openapi-generator/docs/generators/jaxrs-cxf.md
Pablo Lázaro ad8aa7dc0e [Java] adds snapshotVersion CLI option and uses API version as artifactVersion by default (#2033)
* [Java]: adds snapshotVersion CLI option and uses API version as artifactVersion by default

* fix some typos

* fix naming diff between branches

* ensure-up-to-date

* update samples
2019-02-18 17:54:27 +08:00

4.9 KiB


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

Option Description Values Default
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
modelPackage package for generated models null
apiPackage package for generated api classes null
invokerPackage root package for generated code null
groupId groupId in generated pom.xml null
artifactId artifactId in generated pom.xml null
artifactVersion artifact version in generated pom.xml null
artifactUrl artifact URL in generated pom.xml null
artifactDescription artifact description in generated pom.xml null
scmConnection SCM connection in generated pom.xml null
scmDeveloperConnection SCM developer connection in generated pom.xml null
scmUrl SCM URL in generated pom.xml null
developerName developer name in generated pom.xml null
developerEmail developer email in generated pom.xml null
developerOrganization developer organization in generated pom.xml null
developerOrganizationUrl developer organization URL in generated pom.xml null
licenseName The name of the license null
licenseUrl The URL of the license null
sourceFolder source folder for generated code null
serializableModel boolean - toggle "implements Serializable" for generated models false
bigDecimalAsString Treat BigDecimal values as Strings to avoid precision loss. false
fullJavaUtil whether to use fully qualified name for classes under java.util. This option only works for Java API client false
hideGenerationTimestamp hides the timestamp when files were generated null
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
dateLibrary Option. 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
java8 Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64
false
Various third party libraries as needed
null
disableHtmlEscaping Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) false
booleanGetterPrefix Set booleanGetterPrefix (default value 'get') 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
parentArtifactId parent artifactId 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
snapshotVersion Uses a SNAPSHOT version. null
implFolder folder for generated implementation code null
title a title describing the application null
useBeanValidation Use BeanValidation API annotations true
serverPort The port on which the server should be started null
generateSpringApplication Generate Spring application false
useSpringAnnotationConfig Use Spring Annotation Config false
useSwaggerFeature Use Swagger Feature false
useSwaggerUI Use Swagger UI false
useWadlFeature Use WADL Feature false
useMultipartFeature Use Multipart Feature false
useGzipFeature Use Gzip Feature false
useGzipFeatureForTests Use Gzip Feature for tests false
useBeanValidationFeature Use BeanValidation Feature false
useLoggingFeature Use Logging Feature false
useLoggingFeatureForTests Use Logging Feature for tests false
generateSpringBootApplication Generate Spring Boot application false
generateJbossDeploymentDescriptor Generate Jboss Deployment Descriptor false
addConsumesProducesJson Add @Consumes/@Produces Json to API interface false
useAnnotatedBasePath Use @Path annotations for basePath false
generateNonSpringApplication Generate non-Spring application false
useGenericResponse Use generic response false