| 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 |
| apiPackage |
package for generated api classes |
|
org.openapitools.client.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-java-client |
| 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 |
| asyncNative |
If true, async handlers will be used, instead of the sync version |
|
false |
| bigDecimalAsString |
Treat BigDecimal values as Strings to avoid precision loss. |
|
false |
| booleanGetterPrefix |
Set booleanGetterPrefix |
|
get |
| caseInsensitiveResponseHeaders |
Make API response's headers case-insensitive. Available on okhttp-gson, jersey2 libraries |
|
false |
| 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 |
| 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 |
| hideGenerationTimestamp |
Hides the generation timestamp when files are generated. |
|
false |
| invokerPackage |
root package for generated code |
|
org.openapitools.client |
| 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
- 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) to use |
- jersey1
- HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
- jersey2
- HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
- feign
- HTTP client: OpenFeign 10.x. JSON processing: Jackson 2.9.x.
- okhttp-gson
- [DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
- retrofit2
- HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2/3]=true'. (RxJava 1.x or 2.x or 3.x)
- resttemplate
- HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
- webclient
- HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
- resteasy
- HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
- vertx
- HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
- google-api-client
- HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
- rest-assured
- HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.10.x. Only for Java 8
- native
- HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
- microprofile
- HTTP client: Microprofile client 1.x. JSON processing: Jackson 2.9.x
|
okhttp-gson |
| licenseName |
The name of the license |
|
Unlicense |
| licenseUrl |
The URL of the license |
|
http://unlicense.org |
| microprofileFramework |
Framework for microprofile. Possible values "kumuluzee" |
|
null |
| modelPackage |
package for generated models |
|
org.openapitools.client.model |
| openApiNullable |
Enable OpenAPI Jackson Nullable library |
|
true |
| parcelableModel |
Whether to generate models for Android that implement Parcelable with the okhttp-gson library. |
|
false |
| 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 |
Perform BeanValidation |
|
false |
| playVersion |
Version of Play! Framework (possible values "play24" (Deprecated), "play25" (Deprecated), "play26" (Default)) |
|
null |
| prependFormOrBodyParameters |
Add form or body parameters to the beginning of the parameter list. |
|
false |
| scmConnection |
SCM connection in generated pom.xml |
|
scm:git:git@github.com:openapitools/openapi-generator.git |
| scmDeveloperConnection |
SCM developer connection in generated pom.xml |
|
scm:git:git@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 |
| serializationLibrary |
Serialization library, default depends from the library |
- jackson
- Use Jackson as serialization library
- gson
- Use Gson as serialization library
|
null |
| 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 |
| supportJava6 |
Whether to support Java6 with the Jersey1 library. This option has been deprecated and will be removed in the 5.x release |
|
false |
| useAbstractionForFiles |
Use alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate library |
|
false |
| useBeanValidation |
Use BeanValidation API annotations |
|
false |
| useGzipFeature |
Send gzip-encoded requests |
|
false |
| usePlayWS |
Use Play! Async HTTP client (Play WS API) |
|
false |
| useReflectionEqualsHashCode |
Use org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact. |
|
false |
| useRuntimeException |
Use RuntimeException instead of Exception |
|
false |
| useRxJava |
Whether to use the RxJava adapter with the retrofit2 library. IMPORTANT: this option has been deprecated and will be removed in the 5.x release. |
|
false |
| useRxJava2 |
Whether to use the RxJava2 adapter with the retrofit2 library. |
|
false |
| useRxJava3 |
Whether to use the RxJava3 adapter with the retrofit2 library. |
|
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 |