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
e27700cfee
openapi-generator/docs/generators/spring.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

9.0 KiB
Raw Blame History

title sidebar_label
Config Options for spring spring
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
apiFirst Generate the API from the OAI spec at server compile time (API first approach) false
apiPackage package for generated api classes org.openapitools.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-spring
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
async use async Callable controllers false
basePackage base package (invokerPackage) for generated code org.openapitools
bigDecimalAsString Treat BigDecimal values as Strings to avoid precision loss. false
booleanGetterPrefix Set booleanGetterPrefix get
configPackage configuration package for generated code org.openapitools.configuration
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
delegatePattern Whether to generate the server files using the delegate pattern false
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
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
hateoas Use Spring HATEOAS library to allow adding HATEOAS links false
hideGenerationTimestamp Hides the generation timestamp when files are generated. false
implicitHeaders Skip header parameters in the generated API methods using @ApiImplicitParams annotation. false
interfaceOnly Whether to generate only API interface stubs without the server files. false
invokerPackage root package for generated code org.openapitools.api
java8 Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used
false
Various third party libraries as needed
 false
library library template (sub-template)
spring-boot
Spring-boot Server application using the SpringFox integration.
spring-mvc
Spring-MVC Server application using the SpringFox integration.
spring-cloud
Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
 spring-boot
licenseName The name of the license Unlicense
licenseUrl The URL of the license http://unlicense.org
modelPackage package for generated models org.openapitools.model
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 Use Bean Validation Impl. to perform BeanValidation false
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
reactive wrap responses in Mono/Flux Reactor types (spring-boot only) false
responseWrapper wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, HystrixCommand, RxObservable, RxSingle or fully qualified type) null
returnSuccessCode Generated server returns 2xx code 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
singleContentTypes Whether to select only one produces/consumes content-type by operation. false
skipDefaultInterface Whether to generate default implementations for java8 interfaces false
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
swaggerDocketConfig Generate Spring OpenAPI Docket configuration class. false
title server title name or client service name OpenAPI Spring
unhandledException Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives). false
useBeanValidation Use BeanValidation API annotations true
useOptional Use Optional container for optional parameters false
useTags use tags for creating interface and controller classnames false
virtualService Generates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wiki 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