loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-11-04 10:43:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/docs/generators/java.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

10 KiB
Raw Blame History

title sidebar_label
Config Options for java java
Option Description Values Default
additionalModelTypeAnnotations Additional annotations for model type(class level annotations) null
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiPackage package for generated api classes org.openapitools.client.api
artifactDescription artifact description in generated pom.xml OpenAPI Java
artifactId artifactId in generated pom.xml. This also becomes part of the generated library's filename openapi-java-client
artifactUrl artifact URL in generated pom.xml https://github.com/openapitools/openapi-generator
artifactVersion artifact version in generated pom.xml. This also becomes part of the generated library's filename 1.0.0
bigDecimalAsString Treat BigDecimal values as Strings to avoid precision loss. false
booleanGetterPrefix Set booleanGetterPrefix get
caseInsensitiveResponseHeaders Make API response's headers case-insensitive. Available on okhttp-gson, jersey2 libraries 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)
 threetenbp
developerEmail developer email in generated pom.xml team@openapitools.org
developerName developer name in generated pom.xml OpenAPI-Generator Contributors
developerOrganization developer organization in generated pom.xml OpenAPITools.org
developerOrganizationUrl developer organization URL in generated pom.xml http://openapitools.org
disableHtmlEscaping Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
feignVersion Version of OpenFeign: '10.x', '9.x' (default) false
fullJavaUtil whether to use fully qualified name for classes under java.util. This option only works for Java API client false
groupId groupId in generated pom.xml org.openapitools
hideGenerationTimestamp Hides the generation timestamp when files are generated. false
invokerPackage root package for generated code org.openapitools.client
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
library library template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
microprofile
HTTP client: Microprofile client X.x. JSON processing: Jackson 2.9.x
 okhttp-gson
licenseName The name of the license Unlicense
licenseUrl The URL of the license http://unlicense.org
modelPackage package for generated models org.openapitools.client.model
parcelableModel Whether to generate models for Android that implement Parcelable with the okhttp-gson library. false
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 Perform BeanValidation false
playVersion Version of Play! Framework (possible values "play24", "play25" (default), "play26") null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. 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
serializationLibrary Serialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
 null
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
supportJava6 Whether to support Java6 with the Jersey1 library. false
useBeanValidation Use BeanValidation API annotations false
useGzipFeature Send gzip-encoded requests false
usePlayWS Use Play! Async HTTP client (Play WS API) false
useReflectionEqualsHashCode Use org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact. false
useRuntimeException Use RuntimeException instead of Exception false
useRxJava Whether to use the RxJava adapter with the retrofit2 library. false
useRxJava2 Whether to use the RxJava2 adapter with the retrofit2 library. 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/Alias Imports
Array java.util.List
ArrayList java.util.ArrayList
BigDecimal java.math.BigDecimal
Date java.util.Date
DateTime org.joda.time.*
File java.io.File
HashMap java.util.HashMap
List java.util.*
LocalDate org.joda.time.*
LocalDateTime org.joda.time.*
LocalTime org.joda.time.*
Map java.util.Map
Set java.util.*
Timestamp java.sql.Timestamp
URI java.net.URI
UUID java.util.UUID

INSTANTIATION TYPES

Type/Alias Instantiated By
array ArrayList
map HashMap

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