| additionalModelTypeAnnotations |
Additional annotations for model type(class level annotations) |
|
null |
| allowUnicodeIdentifiers |
boolean, toggles whether unicode identifiers are allowed in names or not, default is false |
|
false |
| apiFirst |
Generate the API from the OAI spec at server compile time (API first approach) |
|
false |
| apiPackage |
package for generated api classes |
|
org.openapitools.api |
| artifactDescription |
artifact description in generated pom.xml |
|
OpenAPI Java |
| artifactId |
artifactId in generated pom.xml. This also becomes part of the generated library's filename |
|
openapi-spring |
| artifactUrl |
artifact URL in generated pom.xml |
|
https://github.com/openapitools/openapi-generator |
| artifactVersion |
artifact version in generated pom.xml. This also becomes part of the generated library's filename |
|
1.0.0 |
| async |
use async Callable controllers |
|
false |
| basePackage |
base package (invokerPackage) for generated code |
|
org.openapitools |
| bigDecimalAsString |
Treat BigDecimal values as Strings to avoid precision loss. |
|
false |
| booleanGetterPrefix |
Set booleanGetterPrefix |
|
get |
| configPackage |
configuration package for generated code |
|
org.openapitools.configuration |
| dateLibrary |
Option. Date library to use |
- joda
- Joda (for legacy app only)
- legacy
- Legacy java.util.Date (if you really have a good reason not to use threetenbp
- java8-localdatetime
- Java 8 using LocalDateTime (for legacy app only)
- java8
- Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
- threetenbp
- Backport of JSR310 (preferred for jdk < 1.8)
|
threetenbp |
| delegatePattern |
Whether to generate the server files using the delegate pattern |
|
false |
| developerEmail |
developer email in generated pom.xml |
|
team@openapitools.org |
| developerName |
developer name in generated pom.xml |
|
OpenAPI-Generator Contributors |
| developerOrganization |
developer organization in generated pom.xml |
|
OpenAPITools.org |
| developerOrganizationUrl |
developer organization URL in generated pom.xml |
|
http://openapitools.org |
| disableHtmlEscaping |
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) |
|
false |
| disallowAdditionalPropertiesIfNotPresent |
Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project. |
- false
- The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
- true
- when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.
|
true |
| discriminatorCaseSensitive |
Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client |
|
true |
| ensureUniqueParams |
Whether to ensure parameter names are unique in an operation (rename parameters that are not). |
|
true |
| fullJavaUtil |
whether to use fully qualified name for classes under java.util. This option only works for Java API client |
|
false |
| groupId |
groupId in generated pom.xml |
|
org.openapitools |
| hateoas |
Use Spring HATEOAS library to allow adding HATEOAS links |
|
false |
| hideGenerationTimestamp |
Hides the generation timestamp when files are generated. |
|
false |
| implicitHeaders |
Skip header parameters in the generated API methods using @ApiImplicitParams annotation. |
|
false |
| interfaceOnly |
Whether to generate only API interface stubs without the server files. |
|
false |
| invokerPackage |
root package for generated code |
|
org.openapitools.api |
| java8 |
Use Java8 classes instead of third party equivalents. Starting in 5.x, JDK8 is the default and the support for JDK7, JDK6 has been dropped |
- true
- Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used. IMPORTANT: This option has been deprecated as Java 8 is the default.
- false
- Various third party libraries as needed
|
true |
| legacyDiscriminatorBehavior |
This flag is used by OpenAPITools codegen to influence the processing of the discriminator attribute in OpenAPI documents. This flag has no impact if the OAS document does not use the discriminator attribute. The default value of this flag is set in each language-specific code generator (e.g. Python, Java, go...)using the method toModelName. Note to developers supporting a language generator in OpenAPITools; to fully support the discriminator attribute as defined in the OAS specification 3.x, language generators should set this flag to true by default; however this requires updating the mustache templates to generate a language-specific discriminator lookup function that iterates over {{#mappedModels}} and does not iterate over {{children}}, {{#anyOf}}, or {{#oneOf}}. |
- true
- The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
- false
- The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
|
true |
| library |
library template (sub-template) |
- spring-boot
- Spring-boot Server application using the SpringFox integration.
- spring-mvc
- Spring-MVC Server application using the SpringFox integration.
- spring-cloud
- Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
|
spring-boot |
| licenseName |
The name of the license |
|
Unlicense |
| licenseUrl |
The URL of the license |
|
http://unlicense.org |
| modelPackage |
package for generated models |
|
org.openapitools.model |
| openApiNullable |
Enable OpenAPI Jackson Nullable library |
|
true |
| parentArtifactId |
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |
|
null |
| parentGroupId |
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |
|
null |
| parentVersion |
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |
|
null |
| performBeanValidation |
Use Bean Validation Impl. to perform BeanValidation |
|
false |
| prependFormOrBodyParameters |
Add form or body parameters to the beginning of the parameter list. |
|
false |
| reactive |
wrap responses in Mono/Flux Reactor types (spring-boot only) |
|
false |
| responseWrapper |
wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, HystrixCommand, RxObservable, RxSingle or fully qualified type) |
|
null |
| returnSuccessCode |
Generated server returns 2xx code |
|
false |
| scmConnection |
SCM connection in generated pom.xml |
|
scm git@github.com:openapitools/openapi-generator.git |
| scmDeveloperConnection |
SCM developer connection in generated pom.xml |
|
scmgit@github.com:openapitools/openapi-generator.git |
| scmUrl |
SCM URL in generated pom.xml |
|
https://github.com/openapitools/openapi-generator |
| serializableModel |
boolean - toggle "implements Serializable" for generated models |
|
false |
| singleContentTypes |
Whether to select only one produces/consumes content-type by operation. |
|
false |
| skipDefaultInterface |
Whether to generate default implementations for java8 interfaces |
|
false |
| snapshotVersion |
Uses a SNAPSHOT version. |
- true
- Use a SnapShot Version
- false
- Use a Release Version
|
null |
| sortModelPropertiesByRequiredFlag |
Sort model properties to place required parameters before optional parameters. |
|
true |
| sortParamsByRequiredFlag |
Sort method arguments to place required parameters before optional parameters. |
|
true |
| sourceFolder |
source folder for generated code |
|
src/main/java |
| swaggerDocketConfig |
Generate Spring OpenAPI Docket configuration class. |
|
false |
| title |
server title name or client service name |
|
OpenAPI Spring |
| unhandledException |
Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives). |
|
false |
| useBeanValidation |
Use BeanValidation API annotations |
|
true |
| useOptional |
Use Optional container for optional parameters |
|
false |
| useTags |
use tags for creating interface and controller classnames |
|
false |
| virtualService |
Generates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wiki |
|
false |
| withXml |
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) |
|
false |
b9662dc25d