web-dev-qa-db-fra.com

Swagger Codegen (avec plugin maven) pour OpenAPI 3.0

Je veux utiliser le fichier Swagger Codegen pour OpenAPI 3.0 YAML. Et je vois Swagger Codegen 3.0.0-rc est disponible. Mais lorsque j'essaie de l'utiliser, je rencontre des problèmes. Voici les détails:

Ma pom.xml fichier avec le plugin 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>

Avec le plugin ci-dessus lorsque j'exécute la build maven, j'ai obtenu ce ServiceConfigurationError, voici la trace de la pile:

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)

Afin de résoudre ce problème, j'ai ajouté swagger-codegen-generators dépendance dans la section plugin maven du fichier pom:

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

Donc, avec ce problème mentionné précédemment, il a été résolu, mais maintenant je vois ce 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)

Comme vous l'auriez déjà noté, j'utilise <language>spring</language> et <library>spring-mvc</library>. Veuillez me faire savoir si codegen a fonctionné pour quelqu'un pour 3.0.0-rc0 avec ces configurations.

Note: J'ai regardé ce vieux post qui est similaire mais à cette époque 3.0.0-rc0 n'était pas disponible.

mavenswaggerswagger-codegenopenapiopenapi-generator
12
Kuldeep Jain

Pour utiliser Swagger Codegen avec le plug-in Maven pour la spécification OpenAPI 3.0.0, vous pouvez envisager d'utiliser OpenAPI Generator à la place (qui est une version communautaire de Swagger Codegen).

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

Réf: https://github.com/OpenAPITools/openapi-generator#12---artifacts-on-maven-central

(veuillez vous référer à la Q&A pourquoi nous avons bifurqué Swagger Codegen)

20
William Cheng

Le plugin vav swagger codegen maven sorti en avril 2019 génère des bibliothèques de travail Java client à partir d'une spécification OpenAPI 3.0, j'utilise cette configuration de plugin Maven pom.xml:

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

Toutes les autres entrées de configuration et de configOptions sont inchangées par rapport à la version 2.4.5. J'ai dû remplacer l'ancienne dépendance d'annotation par la suivante pour que le code client se compile:

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

HTH

3
chrisinmtown