Open API 代码生成器 Maven 插件使用旧的 Swagger 2 注释而不是 Swagger 3 注释

我正在使用 Open API 代码生成器 Maven 插件从文件中生成 Open API 3.0。我在我的 pom.xml 中使用了这个插件:

<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>4.3.0</version>

该插件生成 API 时没有任何问题,但它不使用 Swagger v3 注释,而是使用旧的 Swagger 注释。例如,参数使用 @ApiParam 进行注释,而应使用 @Parameter 包中的 io.swagger.v3.oas.annotations 注释:

default ResponseEntity<Fault> getFault(@ApiParam(value = "",required=true) @PathVariable("jobId") String jobId) {

因此,最新的 Swagger UI 无法正确显示文档。当我使用 swagger.v3 注释创建端点时,Swagger UI 工作正常。

根据官方网站 https://openapi-generator.tech/docs/plugins/ ,我应该包括这个依赖:

<dependency>
    <groupId>io.swagger.parser.v3</groupId>
    <artifactId>swagger-parser</artifactId>
</dependency>

但即使有这种依赖关系,插件仍然会生成带有旧注释的源代码。

如何强制 Open API 代码生成器使用 Swagger v3 注释?

stack overflow Open API code generator Maven plugin uses old Swagger 2 annotations instead of Swagger 3 annotations
原文答案

答案:

作者头像

现在发布了该插件的5.3.1版本,我使用了 https://github.com/OpenAPITools/openapi-generator/pull/9775https://github.com/OpenAPITools/openapi-generator/issues/6108 的信息使其对我有用。

我在pom.xml中添加了三个配置:

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>5.3.1</version>
  <configuration>
    <!-- other config omitted -->
    <configOptions>
      <oas3>true</oas3>
      <useSpringController>true</useSpringController>
      <useSpringfox>false</useSpringfox>
    </configOptions>
  </configuration>
</plugin>

之后,可能需要**将另一个依赖项作为解决方法,因为插件将未使用的导入添加到生成的代码中。

<dependency>
  <!-- try to remove this dependency when a new version (5.3.1+) of the openapi-generator plugin is available -->
  <groupId>io.swagger</groupId>
  <artifactId>swagger-annotations</artifactId>
  <version>1.6.3</version>
</dependency>

我正在使用springdoc-openapi-UI依赖性。

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.6.3</version>
</dependency>