openapi-generator/modules/swagger-codegen-maven-plugin
2015-10-25 20:59:52 -07:00
..
src/main/java/io/swagger/codegen/plugin fixed NPE on empty props 2015-10-22 15:43:02 -07:00
pom.xml updated to dev version 2015-10-25 20:59:52 -07:00
README.md updated documentation and removed java-specific parameters from general configuration 2015-06-24 07:31:10 +02:00

swagger-codegen-maven-plugin

A Maven plugin to support the swagger code generation project

Usage

Add to your build->plugins section (default phase is generate-sources phase)

<plugin>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>${project.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <inputSpec>src/main/resources/api.yaml</inputSpec>
                <language>java</language>
                <configOptions>
                   <sourceFolder>src/gen/java/main</sourceFolder>
                </configOptions>
            </configuration>
        </execution>
    </executions>
</plugin>

Followed by:

mvn clean compile

General Configuration parameters

  • inputSpec - swagger spec file path
  • language - target generation language
  • output - target output path (default is ${project.build.directory}/generated-sources/swagger)
  • templateDirectory - directory with mustache templates
  • addCompileSourceRoot - add the output directory to the project as a source root (true by default)
  • modelPackage - the package to use for generated model objects/classes
  • apiPackage - the package to use for generated api objects/classes
  • invokerPackage - the package to use for the generated invoker objects
  • configOptions - a map of language-specific parameters (see below)

Java-specific parameters (under configOptions)

  • sourceFolder - the folder to use for generated sources under the output folder
  • groupId - groupId in generated pom.xml
  • artifactId - artifactId in generated pom.xml
  • artifactVersion - artifact version in generated pom.xml