valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 18:45:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
0f2272d9a4
openapi-generator/docs/generators/jaxrs-cxf-cdi.md
Jim Schubert 0e1ce6bb63
[docs] Custom template clarifications and other minor enhancements (#4167) 
* [docs] Updating docsite outputs to be browsable on Github as well

* Fix links to other files
   Suffix `.md` was needed to make links works

* [docs] Add clarification to differences between customization and templating docs

* [docs] Collapsible side bar, scroll to top, minor enhancements
2019-10-16 18:04:44 -04:00

5.5 KiB
Raw Blame History

title sidebar_label
Config Options for jaxrs-cxf-cdi jaxrs-cxf-cdi
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 org.openapitools.model
apiPackage package for generated api classes org.openapitools.api
invokerPackage root package for generated code org.openapitools.api
groupId groupId in generated pom.xml org.openapitools
artifactId artifactId in generated pom.xml. This also becomes part of the generated library's filename openapi-jaxrs-cxf-cdi-server
artifactVersion artifact version in generated pom.xml. This also becomes part of the generated library's filename 1.0.0
artifactUrl artifact URL in generated pom.xml https://github.com/openapitools/openapi-generator
artifactDescription artifact description in generated pom.xml OpenAPI Java
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
developerName developer name in generated pom.xml OpenAPI-Generator Contributors
developerEmail developer email in generated pom.xml team@openapitools.org
developerOrganization developer organization in generated pom.xml OpenAPITools.org
developerOrganizationUrl developer organization URL in generated pom.xml http://openapitools.org
licenseName The name of the license Unlicense
licenseUrl The URL of the license http://unlicense.org
sourceFolder source folder for generated code src/gen/java
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 generation timestamp when files are generated. 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
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)
 legacy
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
 false
disableHtmlEscaping Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) false
booleanGetterPrefix Set booleanGetterPrefix get
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.
true
Use a SnapShot Version
false
Use a Release Version
 null
implFolder folder for generated implementation code src/main/java
title a title describing the application OpenAPI Server
useBeanValidation Use BeanValidation API annotations true
serverPort The port on which the server should be started 8080
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
 <default>
generatePom Whether to generate pom.xml if the file does not already exist. true
interfaceOnly Whether to generate only API interface stubs without the server files. 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
useSwaggerAnnotations Whether to generate Swagger annotations. 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
useBeanValidation Use BeanValidation API annotations true