更改Spring openapi-generator-maven-plugin生成的接口的返回类型

基础概念

Spring openapi-generator-maven-plugin 是一个 Maven 插件，用于根据 OpenAPI 规范生成客户端代码、服务器存根代码或其他语言的代码。这个插件可以帮助开发者快速生成与 OpenAPI 规范兼容的代码，减少手动编写代码的工作量。

类型

openapi-generator-maven-plugin 可以生成多种类型的代码，包括但不限于：

客户端库
服务器存根
模型类
文档生成器

应用场景

适用于需要根据 OpenAPI 规范自动生成代码的场景，例如：

微服务架构中，客户端和服务端之间的通信。
API 文档生成和管理。
快速原型开发和测试。

更改返回类型的问题

如果你需要更改 openapi-generator-maven-plugin 生成的接口的返回类型，通常有以下几种方法：

方法一：修改 OpenAPI 规范

最直接的方法是修改 OpenAPI 规范文件（通常是 yaml 或 json 文件），在其中指定你需要的返回类型。然后重新运行 openapi-generator-maven-plugin 生成代码。

例如，在 OpenAPI 规范文件中：

paths:
  /example:
    get:
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomResponse'
components:
  schemas:
    CustomResponse:
      type: object
      properties:
        message:
          type: string

方法二：自定义模板

openapi-generator-maven-plugin 支持自定义模板，你可以编写自己的模板文件来控制生成的代码结构。具体步骤如下：

下载模板文件：从 OpenAPI Generator GitHub 仓库下载模板文件。
修改模板文件：根据需要修改模板文件，指定你需要的返回类型。
配置插件：在 pom.xml 中配置插件使用自定义模板。

例如，在 pom.xml 中：

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>5.3.0</version>
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
        <generatorName>java</generatorName>
        <templateDir>${project.basedir}/src/main/resources/templates</templateDir>
        <output>${project.build.directory}/generated-sources</output>
      </configuration>
    </execution>
  </executions>
</plugin>

方法三：后处理生成的代码

如果上述方法都不适用，你可以考虑在代码生成后，手动或使用脚本修改生成的代码，更改返回类型。

示例代码

假设你需要更改生成的接口返回类型为 CustomResponse，可以按照以下步骤操作：

修改 OpenAPI 规范文件：

components:
  schemas:
    CustomResponse:
      type: object
      properties:
        message:
          type: string

配置 pom.xml：

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>5.3.0</version>
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
        <generatorName>java</generatorName>
        <output>${project.build.directory}/generated-sources</output>
      </configuration>
    </execution>
  </executions>
</plugin>