OpenAPI Generator Spring Boot 文件收发集成测试问题咨询

修正OpenAPI YAML的响应定义 #

核心是在响应的schema中明确使用type: string + format: binary，同时绑定text/csv的content-type，这样OpenAPI Generator会生成正确的File类型客户端代码，且Spring默认的转换器能直接处理。

示例YAML片段：

paths:
  /export/csv:
    get:
      summary: 导出CSV文件
      responses:
        '200':
          description: 有效的CSV文件
          content:
            text/csv:
              schema:
                type: string
                format: binary

确认OpenAPI Generator生成参数 #

生成客户端时，确保使用Spring Boot相关的配置参数，让生成器适配Spring的消息转换器机制。示例CLI命令：

openapi-generator generate -i your-api.yaml -g spring -o client-dir \
  --additional-properties=library=spring-boot,useSpringBoot3=true

验证生成的客户端代码 #

正确配置后，生成的客户端接口应该返回ResponseEntity<File>，示例：

@GetMapping(value = "/export/csv", produces = "text/csv")
ResponseEntity<File> exportCsv();

此时Spring的ResourceHttpMessageConverter（默认已注册）会自动处理text/csv类型与File的转换，无需自定义转换器。

问题根源说明 #

• 之前未指定format: binary时，OpenAPI Generator无法正确映射File类型与text/csv的关联，导致客户端找不到合适的转换器；
• 改成format: byte虽然能工作，但会生成byte[]类型，不符合你期望的File类型需求；
• binary是OpenAPI规范中用于二进制文件的标准格式，Spring生态对这个配置生成的File类型支持完善，能直接复用默认转换器。

内容的提问来源于stack exchange，提问作者frankmurphy