web-dev-qa-db-ja.com

OpenAPI 3.0のSwagger Codegen（Mavenプラグイン付き）

OpenAPI 3.0 YAMLファイルにSwagger Codegenを使用します。 Swagger Codegen 3.0.0-rc が利用可能です。しかし、それを使用しようとすると、問題が発生します。詳細は次のとおりです。

僕の pom.xml swagger-codegenプラグインを含むファイル：

<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が得られました。スタックトレースは次のとおりです。

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)

これを修正するために、swagger-codegen-generators依存関係、pomファイルのmavenプラグインセクション内：

<dependencies>
  <dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-generators</artifactId>
    <version>1.0.0-SNAPSHOT</version>
  </dependency>
</dependencies>

先ほど述べたこの問題は解決されましたが、今ではこの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>。これらの構成で3.0.0-rc0の誰かのためにcodegenが機能したかどうかを教えてください。

注：私はこの古いものを見ました post これは似ていますが、当時は3.0.0-rc0は利用できませんでした。

mavenswaggerswagger-codegenopenapiopenapi-generator
12
Kuldeep Jain

OpenAPI 3.0.0仕様のMavenプラグインでSwagger Codegenを使用するには、代わりに OpenAPI Generator （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を分岐した理由については Q＆A を参照してください）

20
William Cheng

2019年4月にリリースされたv3 swagger codegen mavenプラグインは、OpenAPI 3.0仕様から動作するJavaクライアントライブラリ、私はこのMaven pom.xmlプラグイン構成を使用しています：

<plugin>
    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>3.0.8</version>
    <executions>
    ..

残りの構成およびconfigOptionsエントリはすべて、バージョン2.4.5から変更されていません。クライアントコードがコンパイルされるように、古いアノテーションの依存関係を次のものに置き換える必要がありました。

    <dependency>
        <groupId>io.swagger.core.v3</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>2.0.8</version>
    </dependency>

HTH

3
chrisinmtown