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

Question

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

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

我们如何为ResponseEntity指定替代的主体类型？ （例如本博客中描述的StreamingResponseBody ）

Answer 1

OpenAPI 生成器有一个名为typeMappings的配置选项，它允许您将 OpenApi 基本类型（例如数组、浮点数等）的默认映射更改为相应的 java class (java.util.List, Float, ... ）。

在您的特定情况下，您可以尝试将“二进制”类型 map 转换为与“java.util.File”不同的东西。

默认映射在此处定义 - 参见第 1464 行