如何将swagger maven codegen插件与openapi 3.0(java+spring boot 2.2.4)结合使用

jm2pwxwz  于 2021-07-13  发布在  Java
关注(0)|答案(0)|浏览(246)

我有一个api,我正试图重写它,它使用了老的swagger maven codegen 2.3.1和spring1.5.9的遗留版本。我跑的时候能看出来 mvn package 或者 mvn install ,插件生成所有控制器实现的接口。所有这些当然都是在swagger.yaml文件中定义的。
我按照他们的github repo遵循了招摇过市的codegen指令(https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin)它只是简单地声明将它添加到 build -> plugins pom.xml的部分。因此,这对于他们在示例中使用的codegen版本2.3.1很好,但是对于版本>=3.0.0不起作用。现在,你可能会告诉我“嘿,那就用2.3.1吧”,但我想用openapi规范3,根据我的研究,它必须有swagger codegen版本>=3.0.0。参考文献:
如何修复java.lang.runtimeexception:缺少swagger输入或配置?
现在,通常您只需在pom中更新插件版本,但是由于某些原因,当我使用>=3.0.0的插件版本时,我的代码从不编译或运行。我在intellij中收到以下错误消息:

The POM for io.swagger:swagger-codegen-maven-plugin:jar:3.0.0 is missing, no dependency information available

所以他们让我相信我的组、工件或repo是错误的,所以我开始尝试在mavencentral url上找到这个jar的确切路径,我注意到除了3.0.0-rc0和3.0.0-rc1的这两个变体之外,我没有看到任何3.x.x的版本,你可以在这里看到:https://repo1.maven.org/maven2/io/swagger/swagger-codegen-maven-plugin/
瞧,当我在pom版本中尝试3.0.0-rc1时,我的代码开始编译。我有一个样例swaggerapi.yaml文件,我正在阅读这个文件(非常基本,只是为了测试),然后我开始看到了 okhttp 包裹不见了,或者我在pom里也不见了。但是,我确实看到它试图在/target output direct中生成服务器存根,这是我在pom.xml配置中为插件定义的,所以这很好:

所以我想我的问题在这一点上总结;dr是:
我应该使用的openapi是-2还是3?3是新的,所以我觉得这很明显
如果是openapi3,我如何在pom中使用swagger codegen plugin version>=3?为什么我不能解决依赖关系?我缺乏对依赖关系和插件依赖关系的理解,这会伤害我吗?
当我把这个3.0.0-rc1 swagger 的codegen版本放进去的时候,为什么会出现这些okhttp错误呢?有没有一个指南可以显示使用这个插件所需的端到端的完整设置?
即使在我以前的代码中,@controllers也实现了在/target目录中生成的接口。我在swagger.yaml中没有看到它们的接口名,所以我想知道这是什么设计模式,或者这些说明在swagger文档中的什么地方?
不管怎样,是的,如果有人能帮我,或者解释一下这些事情,或者给我看一篇文章,这篇文章实际上展示了如何从头到尾使用swagger codegen创建api,我将不胜感激!
我的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.mydomain.me</groupId>
    <artifactId>my-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>My API</name>
    <description>Version 2.0 of my API</description>
    <properties>
        <java.version>11</java.version>
    </properties>

    <pluginRepositories>
        <pluginRepository>
            <id>central</id>
            <name>Maven Central</name>
            <layout>default</layout>
            <url>https://repo1.maven.org/maven2</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>io.swagger.codegen.v3</groupId>
            <artifactId>swagger-codegen-cli</artifactId>
            <version>3.0.25</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>io.swagger</groupId>
                <artifactId>swagger-codegen-maven-plugin</artifactId>
                <version>3.0.0-rc1</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
                            <output>${project.basedir}/target/generated-sources</output>
                            <language>java</language>
                            <configOptions>
                                <sourceFolder>src/gen/java/main</sourceFolder>
                            </configOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

如果你想看的话,我也可以和你分享我的招摇.yaml。

暂无答案!

目前还没有任何答案,快来回答吧!

相关问题