如何在 OpenAPI 中自定义响应实体的主体类型？答案

【问题标题】：How to customise the body type of response entity in OpenAPI?如何在 OpenAPI 中自定义响应实体的主体类型？
【发布时间】：2021-08-08 18:11:47
【问题描述】：

我正在开发一个允许用户从端点下载 CSV 文件的 Spring 项目。

OpenAPI Generator 用于代码生成。根据the documentation 的“返回文件的响应”部分，响应的架构可以定义为type: string 和format: binary。生成的界面将类似于： CompletableFuture<ResponseEntity<org.springframework.core.io.Resource>> downloadFile().

我们如何为ResponseEntity 指定另一种正文类型？（例如，this blog 中描述的StreamingResponseBody）

【问题讨论】：

标签： java spring rest openapi

【解决方案1】：

OpenAPI 生成器有一个名为typeMappings 的配置选项，它允许您更改 OpenApi 原始类型（如数组、浮点等）到相应 java 类（java.util.List、浮动，...）。

在您的特定情况下，您可以尝试将“二进制”类型映射到与“java.util.File”不同的内容。

默认映射定义为 here - 参见第 1464 行

【讨论】：