| 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 |
| 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-jaxrs-server |
| 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 |
| 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 |
| 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+)
| legacy |
| 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 |
| 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 |
| generateBuilders | Whether to generate builders for models | | false |
| generateConstructorWithAllArgs | whether to generate a constructor for all arguments | | false |
| generatePom | Whether to generate pom.xml if the file does not already exist. | | true |
| 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 |
| implFolder | folder for generated implementation code | | src/main/java |
| 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 |
| interfaceOnly | Whether to generate only API interface stubs without the server files. | | false |
| invokerPackage | root package for generated code | | org.openapitools.api |
| 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) | - <default>
- JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
- quarkus
- Server using Quarkus
- thorntail
- Server using Thorntail
- openliberty
- Server using Open Liberty
- helidon
- Server using Helidon
- kumuluzee
- Server using KumuluzEE
| <default> |
| 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 |
| openApiSpecFileLocation | Location where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string. | | null |
| 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 |
| prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | | false |
| returnResponse | Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. | | 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 |
| serverPort | The port on which the server should be started | | 8080 |
| 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/gen/java |
| supportAsync | Wrap responses in CompletionStage type, allowing asynchronous computation (requires JAX-RS 2.1). | | false |
| testOutput | Set output folder for models and APIs tests | | ${project.build.directory}/generated-test-sources/openapi |
| title | a title describing the application | | OpenAPI Server |
| useBeanValidation | Use BeanValidation API annotations | | true |
| useJakartaEe | whether to use Jakarta EE namespace instead of javax | | false |
| useMicroProfileOpenAPIAnnotations | Whether to generate Microprofile OpenAPI annotations. Only valid when library is set to quarkus. | | false |
| useMutiny | Whether to use Smallrye Mutiny instead of CompletionStage for asynchronous computation. Only valid when library is set to quarkus. | | 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 |
| useSwaggerAnnotations | Whether to generate Swagger annotations. | | true |
| useTags | use tags for creating interface and controller classnames | | 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 |