OpenApi 3.0 SpringBoot 控制器使用

Question

使用 openapi maven 插件：

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

并使用 pom 配置生成 Spring Boot 控制器，例如：

     <plugin>
        <groupId>org.openapitools</groupId>
        <artifactId>openapi-generator-maven-plugin</artifactId>
        <version>4.2.2</version>
        <executions>
          <execution>
            <id>spring-server</id>
            <goals>
              <goal>generate</goal>
            </goals>
            <configuration>
              <!-- specify the swagger yaml -->
              <inputSpec>${project.resources[0].directory}/pet-store.yaml</inputSpec>
              <!-- target to generate java client code -->
              <generatorName>spring</generatorName>
              <!-- pass any necessary config options -->
              <configOptions>
                <serializableModel>true</serializableModel>
                <snapshotVersion>true</snapshotVersion>
              </configOptions>

            </configuration>
          </execution>

        </executions>
      </plugin>

将生成这样的控制器：

@Controller
@RequestMapping("${openapi.openAPIPetstore.base-path:/v2}")
public class StoreApiController implements StoreApi {

    private final NativeWebRequest request;

    @org.springframework.beans.factory.annotation.Autowired
    public StoreApiController(NativeWebRequest request) {
        this.request = request;
    }

    @Override
    public Optional<NativeWebRequest> getRequest() {
        return Optional.ofNullable(request);
    }

}

这很棒，但是如何绑定到 this 以添加业务逻辑而不更改实际生成的代码？ 如果我扩展控制器以添加业务逻辑，我会遇到各种问题。

你应该如何使用这个生成的代码，扩展它以添加正确的业务逻辑而不改变生成的代码，这会很糟糕。？

Answer 1

我在尝试处理 OAS 3.0 并因此使用提到的openapi-generator-maven-plugin遇到了您的问题。 同时，我让它准确地生成了您所描述的内容。

我建议通过

1. 将您的模型和 API 类从您的代码生成到一个单独的包中，并且
2. 将 Spring 的@ComponentScan注释配置为不包含生成的类（单独使用basePackages属性或将其与显式的excludeFilters属性结合使用）。

是的，修改生成的类是不好的。 我只是将它们用作创建实际控制器的起点。

修正：在以各种方式配置代码生成后，我找到了仅创建 API（接口）的最佳解决方案。 这样我就可以实现我的控制器，而不会受到另一个实现的干扰。

为了实现这一点，我的插件配置现在看起来像这样（使用configOptions/interfaceOnly选项）：

            <plugin>
                <!-- generate REST API from spec -->
                <groupId>org.openapitools</groupId>
                <artifactId>openapi-generator-maven-plugin</artifactId>
                <version>4.2.2</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
                            <generatorName>spring</generatorName>
                            <generateModels>true</generateModels>
                            <generateApis>true</generateApis>
                            <generateApiDocumentation>true</generateApiDocumentation>
                            <generateSupportingFiles>true</generateSupportingFiles>
                            <modelPackage>example.openapi.model</modelPackage>
                            <apiPackage>example.openapi.api</apiPackage>
                            <package>example.openapi</package>
                            <output>${generated.sources.restapi.dir}</output>
                            <configOptions>
                                <interfaceOnly>true</interfaceOnly>
                                <dateLibrary>java8-localdatetime</dateLibrary>
                                <java8>true</java8>
                                <useBeanValidation>true</useBeanValidation>
                            </configOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>