OpenAPI Generator

OpenAPI Generator

  • Get Started
  • Generators
  • Roadmap
  • Team
  • FAQ
  • Blog

generators/jaxrs-cxf-extended


id: generator-opts-server-jaxrs-cxf-extended title: Config Options for jaxrs-cxf-extended sidebar_label: jaxrs-cxf-extended


OptionDescriptionValuesDefault
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
modelPackagepackage for generated modelsnull
apiPackagepackage for generated api classesnull
invokerPackageroot package for generated codenull
groupIdgroupId in generated pom.xmlnull
artifactIdartifactId in generated pom.xmlnull
artifactVersionartifact version in generated pom.xmlnull
artifactUrlartifact URL in generated pom.xmlnull
artifactDescriptionartifact description in generated pom.xmlnull
scmConnectionSCM connection in generated pom.xmlnull
scmDeveloperConnectionSCM developer connection in generated pom.xmlnull
scmUrlSCM URL in generated pom.xmlnull
developerNamedeveloper name in generated pom.xmlnull
developerEmaildeveloper email in generated pom.xmlnull
developerOrganizationdeveloper organization in generated pom.xmlnull
developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
licenseNameThe name of the licensenull
licenseUrlThe URL of the licensenull
sourceFoldersource folder for generated codenull
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
hideGenerationTimestamphides the timestamp when files were generatednull
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
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)
null
java8Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64
false
Various third party libraries as needed
null
disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
booleanGetterPrefixSet booleanGetterPrefix (default value 'get')null
parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentArtifactIdparent artifactId 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
snapshotVersionUses a SNAPSHOT version.null
implFolderfolder for generated implementation codenull
titlea title describing the applicationnull
useBeanValidationUse BeanValidation API annotationstrue
serverPortThe port on which the server should be startednull
generateSpringApplicationGenerate Spring applicationfalse
useSpringAnnotationConfigUse Spring Annotation Configfalse
useSwaggerFeatureUse Swagger Featurefalse
useSwaggerUIUse Swagger UIfalse
useWadlFeatureUse WADL Featurefalse
useMultipartFeatureUse Multipart Featurefalse
useGzipFeatureUse Gzip Featurefalse
useGzipFeatureForTestsUse Gzip Feature for testsfalse
useBeanValidationFeatureUse BeanValidation Featurefalse
useLoggingFeatureUse Logging Featurefalse
useLoggingFeatureForTestsUse Logging Feature for testsfalse
generateSpringBootApplicationGenerate Spring Boot applicationfalse
generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
useAnnotatedBasePathUse @Path annotations for basePathfalse
generateNonSpringApplicationGenerate non-Spring applicationfalse
useGenericResponseUse generic responsefalse
supportMultipleSpringServicesSupport generation of Spring services from multiple specificationsfalse
generateOperationBodyGenerate fully functional operation bodiesfalse
loadTestDataFromFileLoad test data from a generated JSON filefalse
testDataFileJSON file to contain generated test datanull
testDataControlFileJSON file to control test data generationnull
Last updated on 2019-3-2
OpenAPI Generator
Docs
Customizing GeneratorsWorkflow Integrations
Community
User ShowcaseStack OverflowChat RoomTwitter
More
BlogGitHub RepoStar
Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))