适用于 OpenAPI 3.0 的 Swagger Codegen(带有 maven 插件) [英] Swagger Codegen (with maven plugin) for OpenAPI 3.0
问题描述
我想为 OpenAPI 3.0 YAML 文件使用 Swagger Codegen.我看到 Swagger Codegen 3.0.0-rc0 可用.但是当我尝试使用它时,我遇到了问题.详情如下:
I want to use Swagger Codegen for OpenAPI 3.0 YAML file. And I see Swagger Codegen 3.0.0-rc0 is available. But when I try to use that I run into issues. Following are the details:
我的 pom.xml
文件带有 swagger-codegen 插件:
My pom.xml
file with swagger-codegen plugin:
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>3.0.0-rc0</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<inputSpec>${basedir}/src/main/resources/mySpec.yaml</inputSpec>
<output>target/generated-sources</output>
<language>spring</language>
<generateApis>false</generateApis>
<modelPackage>com.kj.model</modelPackage>
<apiPackage>com.kj</apiPackage>
<configOptions>
<sourceFolder>swagger</sourceFolder>
<library>spring-mvc</library>
<interfaceOnly>true</interfaceOnly>
<useBeanValidation>true</useBeanValidation>
<dateLibrary>java8</dateLibrary>
<java8>true</java8>
</configOptions>
</configuration>
</execution>
</executions>
</plugin>
使用上面的插件,当我运行 maven 构建时,我得到了这个 ServiceConfigurationError
,这里是堆栈跟踪:
With the above plugin when I run the maven build, I got this ServiceConfigurationError
, here is the stack trace:
Exception in thread "main" java.util.ServiceConfigurationError: io.swagger.codegen.CodegenConfig: Provider io.swagger.codegen.languages.java.JavaClientCodegen not found
at java.util.ServiceLoader.fail(ServiceLoader.java:239)
at java.util.ServiceLoader.access$300(ServiceLoader.java:185)
at java.util.ServiceLoader$LazyIterator.nextService(ServiceLoader.java:372)
at java.util.ServiceLoader$LazyIterator.next(ServiceLoader.java:404)
at java.util.ServiceLoader$1.next(ServiceLoader.java:480)
at io.swagger.codegen.CodegenConfigLoader.forName(CodegenConfigLoader.java:19)
at io.swagger.codegen.config.CodegenConfigurator.toClientOptInput(CodegenConfigurator.java:392)
at io.swagger.codegen.plugin.CodeGenMojo.execute(CodeGenMojo.java:512)
at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:134)
为了解决这个问题,我在 pom 文件的 maven 插件 部分中添加了 swagger-codegen-generators
依赖项:
In order to fix this I added swagger-codegen-generators
dependency within the maven plugin section of pom file:
<dependencies>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-generators</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
所以前面提到的这个问题得到了解决,但现在我看到了这个 NPE
So with this earlier mentioned issue got resolved but now I see this NPE
java.lang.NullPointerException
at io.swagger.codegen.languages.SpringCodegen.preprocessOpenAPI(SpringCodegen.java:429)
at io.swagger.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:199)
at io.swagger.codegen.DefaultGenerator.generate(DefaultGenerator.java:716)
at io.swagger.codegen.plugin.CodeGenMojo.execute(CodeGenMojo.java:534)
at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:134)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:208)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:154)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:146)
at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:117)
正如您已经注意到的那样,我正在使用 <language>spring</language>
和 <library>spring-mvc</library>
.请让我知道 codegen 是否适用于具有这些配置的 3.0.0-rc0 的某人.
As you would have noted already that I am using <language>spring</language>
and <library>spring-mvc</library>
. Please let me know if codegen has worked for someone for 3.0.0-rc0 with these configurations.
注意:我查看了这个旧的帖子,它是类似的,但当时3.0.0-rc0
不可用.
Note: I looked at this old post which is similar but at that time 3.0.0-rc0
was not available.
推荐答案
要将 Swagger Codegen 与 OpenAPI 3.0.0 规范的 Maven 插件一起使用,您可以考虑使用 OpenAPI Generator (这是 Swagger Codegen 的社区驱动版本).
To use Swagger Codegen with Maven plug-in for OpenAPI 3.0.0 spec, you may consider using OpenAPI Generator instead (which is a community-driven version of Swagger Codegen).
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>3.3.4</version>
</dependency>
参考:https://github.com/OpenAPITools/openapi-generator#12---artifacts-on-maven-central
(请参考问答关于我们为什么分叉 Swagger Codegen)
(please refer to the Q&A on why we forked Swagger Codegen)
这篇关于适用于 OpenAPI 3.0 的 Swagger Codegen(带有 maven 插件)的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!