| additionalEnumTypeAnnotations | Additional annotations for enum type(class level annotations) | | null |
| additionalModelTypeAnnotations | Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows) | | null |
| additionalOneOfTypeAnnotations | Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows) | | null |
| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | | false |
| annotationLibrary | Select the complementary documentation annotation library. | - none
- Do not annotate Model and Api with complementary annotations.
- swagger1
- Annotate Model and Api using the Swagger Annotations 1.x library.
- swagger2
- Annotate Model and Api using the Swagger Annotations 2.x library.
| none |
| 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. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option. | | 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 |
| camelCaseDollarSign | Fix camelCase when starting with $ sign. when true : $Value when false : $value | | false |
| caseInsensitiveResponseHeaders | Make API response's headers case-insensitive. Available on okhttp-gson, jersey2 libraries | | false |
| configKey | Config key in @RegisterRestClient. Default to none. Only microprofile supports this option. | | null |
| containerDefaultToNull | Set containers (array, set, map) default to null | | false |
| dateLibrary | Option. Date library to use | - joda
- Joda (for legacy app only)
- legacy
- Legacy java.util.Date
- java8-localdatetime
- Java 8 using LocalDateTime (for legacy app only)
- java8
- Java 8 native JSR310 (preferred for jdk 1.8+)
| java8 |
| 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 | If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. | - false
- The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
- true
- Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
| true |
| discriminatorCaseSensitive | Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client | | true |
| documentationProvider | Select the OpenAPI documentation provider. | - none
- Do not publish an OpenAPI specification.
- source
- Publish the original input OpenAPI specification.
| source |
| dynamicOperations | Generate operations dynamically at runtime from an OAS | | false |
| ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | | true |
| enumUnknownDefaultCase | If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case. | - false
- No changes to the enum's are made, this is the default option.
- true
- With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
| false |
| errorObjectType | Error Object type. (This option is for okhttp-gson-next-gen only) | | null |
| generateClientAsBean | For resttemplate, configure whether to create ApiClient.java and Apis clients as bean (with @Component annotation). | | false |
| gradleProperties | Append additional Gradle properties to the gradle.properties file | | null |
| groupId | groupId in generated pom.xml | | org.openapitools |
| hideGenerationTimestamp | Hides the generation timestamp when files are generated. | | false |
| ignoreAnyOfInEnum | Ignore anyOf keyword in enum | | false |
| implicitHeaders | Skip header parameters in the generated API methods using @ApiImplicitParams annotation. | | false |
| implicitHeadersRegex | Skip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=true | | null |
| invokerPackage | root package for generated code | | org.openapitools.client |
| legacyDiscriminatorBehavior | Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default). | - 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 | - jersey2
- HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
- jersey3
- HTTP client: Jersey client 3.x. JSON processing: Jackson 2.x
- feign
- HTTP client: OpenFeign 10.x. JSON processing: Jackson 2.9.x. or Gson 2.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: JSON-B or Jackson 2.9.x
- apache-httpclient
- HTTP client: Apache httpclient 5.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 |
| microprofileMutiny | Whether to use async types for microprofile (currently only Smallrye Mutiny is supported). | | null |
| microprofileRestClientVersion | Version of MicroProfile Rest Client API. | | 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 |
| 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 on value of the option library | - jsonb
- Use JSON-B as serialization 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 |
| supportStreaming | Support streaming endpoint (beta) | | false |
| supportUrlQuery | Generate toUrlQueryString in POJO (default to true). Available on native, apache-httpclient libraries. | | false |
| testOutput | Set output folder for models and APIs tests | | ${project.build.directory}/generated-test-sources/openapi |
| useAbstractionForFiles | Use alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate, webclient, libraries | | false |
| useBeanValidation | Use BeanValidation API annotations | | false |
| useEnumCaseInsensitive | Use equalsIgnoreCase when String for enum comparison | | false |
| useGzipFeature | Send gzip-encoded requests | | false |
| useJakartaEe | whether to use Jakarta EE namespace instead of javax | | false |
| useOneOfDiscriminatorLookup | Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option. | | false |
| useOneOfInterfaces | whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface | | 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. Only jersey2, jersey3, okhttp-gson, vertx, microprofile support this option. | | false |
| useRxJava2 | Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated. | | false |
| useRxJava3 | Whether to use the RxJava3 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated. | | false |
| useSingleRequestParameter | Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. ONLY jersey2, jersey3, okhttp-gson, microprofile support this option. | | false |
| webclientBlockingOperations | Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync | | false |
| withAWSV4Signature | whether to include AWS v4 signature support (only available for okhttp-gson 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 |