Config Options for spring

OptionDescriptionValuesDefault
additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
apiPackagepackage for generated api classesorg.openapitools.api
artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
asyncuse async Callable controllersfalse
basePackagebase package (invokerPackage) for generated codeorg.openapitools
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
booleanGetterPrefixSet booleanGetterPrefixget
configPackageconfiguration package for generated codeorg.openapitools.configuration
dateLibraryOption. 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
delegatePatternWhether to generate the server files using the delegate patternfalse
developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
groupIdgroupId in generated pom.xmlorg.openapitools
hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
hideGenerationTimestampHides the generation timestamp when files are generated.false
implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
interfaceOnlyWhether to generate only API interface stubs without the server files.false
invokerPackageroot package for generated codeorg.openapitools.api
java8Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used
false
Various third party libraries as needed
false
legacyDiscriminatorBehaviorThis 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.

When this flag is set to 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.

  • Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing. When this flag is set to true:

  • The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document. 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| |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| |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: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| |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|

IMPORT MAPPING

Type/AliasImports
Arrayjava.util.List
ArrayListjava.util.ArrayList
BigDecimaljava.math.BigDecimal
Datejava.util.Date
DateTimeorg.joda.time.*
Filejava.io.File
HashMapjava.util.HashMap
Listjava.util.*
LocalDateorg.joda.time.*
LocalDateTimeorg.joda.time.*
LocalTimeorg.joda.time.*
Mapjava.util.Map
Setjava.util.*
Timestampjava.sql.Timestamp
URIjava.net.URI
UUIDjava.util.UUID

INSTANTIATION TYPES

Type/AliasInstantiated By
arrayArrayList
mapHashMap

LANGUAGE PRIMITIVES

  • Boolean
  • Double
  • Float
  • Integer
  • Long
  • Object
  • String
  • boolean
  • byte[]

RESERVED WORDS

  • abstract
  • apiclient
  • apiexception
  • apiresponse
  • assert
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • configuration
  • const
  • continue
  • default
  • do
  • double
  • else
  • enum
  • extends
  • final
  • finally
  • float
  • for
  • goto
  • if
  • implements
  • import
  • instanceof
  • int
  • interface
  • localreturntype
  • localvaraccept
  • localvaraccepts
  • localvarauthnames
  • localvarcollectionqueryparams
  • localvarcontenttype
  • localvarcontenttypes
  • localvarcookieparams
  • localvarformparams
  • localvarheaderparams
  • localvarpath
  • localvarpostbody
  • localvarqueryparams
  • long
  • native
  • new
  • null
  • object
  • package
  • private
  • protected
  • public
  • return
  • short
  • static
  • strictfp
  • stringutil
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • transient
  • try
  • void
  • volatile
  • while

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePath✓ToolingExtension
Authorizations✗ToolingExtension
UserAgent✗ToolingExtension

Data Type Feature

NameSupportedDefined By
Custom✗OAS2,OAS3
Int32✓OAS2,OAS3
Int64✓OAS2,OAS3
Float✓OAS2,OAS3
Double✓OAS2,OAS3
Decimal✓ToolingExtension
String✓OAS2,OAS3
Byte✓OAS2,OAS3
Binary✓OAS2,OAS3
Boolean✓OAS2,OAS3
Date✓OAS2,OAS3
DateTime✓OAS2,OAS3
Password✓OAS2,OAS3
File✓OAS2
Array✓OAS2,OAS3
Maps✓ToolingExtension
CollectionFormat✓OAS2
CollectionFormatMulti✓OAS2
Enum✓OAS2,OAS3
ArrayOfEnum✓ToolingExtension
ArrayOfModel✓ToolingExtension
ArrayOfCollectionOfPrimitives✓ToolingExtension
ArrayOfCollectionOfModel✓ToolingExtension
ArrayOfCollectionOfEnum✓ToolingExtension
MapOfEnum✓ToolingExtension
MapOfModel✓ToolingExtension
MapOfCollectionOfPrimitives✓ToolingExtension
MapOfCollectionOfModel✓ToolingExtension
MapOfCollectionOfEnum✓ToolingExtension

Documentation Feature

NameSupportedDefined By
Readme✓ToolingExtension
Model✓ToolingExtension
Api✓ToolingExtension

Global Feature

NameSupportedDefined By
Host✓OAS2,OAS3
BasePath✓OAS2,OAS3
Info✓OAS2,OAS3
Schemes✗OAS2,OAS3
PartialSchemes✓OAS2,OAS3
Consumes✓OAS2
Produces✓OAS2
ExternalDocumentation✓OAS2,OAS3
Examples✓OAS2,OAS3
XMLStructureDefinitions✓OAS2,OAS3
MultiServer✗OAS3
ParameterizedServer✗OAS3
ParameterStyling✗OAS3
Callbacks✗OAS3
LinkObjects✗OAS3

Parameter Feature

NameSupportedDefined By
Path✓OAS2,OAS3
Query✓OAS2,OAS3
Header✓OAS2,OAS3
Body✓OAS2
FormUnencoded✓OAS2
FormMultipart✓OAS2
Cookie✗OAS3

Schema Support Feature

NameSupportedDefined By
Simple✓OAS2,OAS3
Composite✓OAS2,OAS3
Polymorphism✓OAS2,OAS3
Union✗OAS3

Security Feature

NameSupportedDefined By
BasicAuth✓OAS2,OAS3
ApiKey✓OAS2,OAS3
OpenIDConnect✗OAS3
BearerToken✗OAS3
OAuth2_Implicit✓OAS2,OAS3
OAuth2_Password✓OAS2,OAS3
OAuth2_ClientCredentials✓OAS2,OAS3
OAuth2_AuthorizationCode✓OAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSON✓OAS2,OAS3
XML✓OAS2,OAS3
PROTOBUF✗ToolingExtension
Custom✓OAS2,OAS3
Edit this page
Last updated on by Justin Black