Config Options for jaxrs-cxf-extended

OptionDescriptionValuesDefault
addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
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-cxf-server
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
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
booleanGetterPrefixSet booleanGetterPrefixget
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)
legacy
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
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
generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
generateNonSpringApplicationGenerate non-Spring applicationfalse
generateOperationBodyGenerate fully functional operation bodiesfalse
generateSpringApplicationGenerate Spring applicationfalse
generateSpringBootApplicationGenerate Spring Boot applicationfalse
groupIdgroupId in generated pom.xmlorg.openapitools
hideGenerationTimestampHides the generation timestamp when files are generated.false
implFolderfolder for generated implementation codesrc/main/java
invokerPackageroot package for generated codeorg.openapitools.api
java8Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64
false
Various third party libraries as needed
false
licenseNameThe name of the licenseUnlicense
licenseUrlThe URL of the licensehttp://unlicense.org
loadTestDataFromFileLoad test data from a generated JSON filefalse
modelPackagepackage for generated modelsorg.openapitools.model
parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
serverPortThe port on which the server should be started8080
snapshotVersionUses a SNAPSHOT version.
true
Use a SnapShot Version
false
Use a Release Version
null
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
sourceFoldersource folder for generated codesrc/main/java
supportMultipleSpringServicesSupport generation of Spring services from multiple specificationsfalse
testDataControlFileJSON file to control test data generationnull
testDataFileJSON file to contain generated test datanull
titlea title describing the applicationOpenAPI Server
useAnnotatedBasePathUse @Path annotations for basePathfalse
useBeanValidationUse BeanValidation API annotationstrue
useBeanValidationFeatureUse BeanValidation Featurefalse
useGenericResponseUse generic responsefalse
useGzipFeatureUse Gzip Featurefalse
useGzipFeatureForTestsUse Gzip Feature for testsfalse
useLoggingFeatureUse Logging Featurefalse
useLoggingFeatureForTestsUse Logging Feature for testsfalse
useMultipartFeatureUse Multipart Featurefalse
useSpringAnnotationConfigUse Spring Annotation Configfalse
useSwaggerFeatureUse Swagger Featurefalse
useSwaggerUIUse Swagger UIfalse
useWadlFeatureUse WADL Featurefalse
withXmlwhether 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.LocalDate
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
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
ArrayOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3
Last updated on by Sebastien Rosset