2015-06-22 18:17:29 +00:00
|
|
|
swagger-codegen-maven-plugin
|
|
|
|
|
============================
|
|
|
|
|
|
|
|
|
|
A Maven plugin to support the [swagger](http://swagger.io) code generation project
|
|
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
============================
|
|
|
|
|
|
|
|
|
|
Add to your `build->plugins` section (default phase is `generate-sources` phase)
|
|
|
|
|
```xml
|
|
|
|
|
<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>
|
2015-06-24 05:31:10 +00:00
|
|
|
<configOptions>
|
|
|
|
|
<sourceFolder>src/gen/java/main</sourceFolder>
|
|
|
|
|
</configOptions>
|
2015-06-22 18:17:29 +00:00
|
|
|
</configuration>
|
|
|
|
|
</execution>
|
|
|
|
|
</executions>
|
|
|
|
|
</plugin>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Followed by:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
mvn clean compile
|
|
|
|
|
```
|
|
|
|
|
|
2015-06-24 05:31:10 +00:00
|
|
|
### General Configuration parameters
|
2015-06-22 18:17:29 +00:00
|
|
|
|
|
|
|
|
- `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)
|
2015-06-24 05:31:10 +00:00
|
|
|
- `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
|
