openapi-generator/docs/generators/groovy.md

title	sidebar_label
Config Options for groovy	groovy

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.api
artifactId	artifactId in generated pom.xml. This also becomes part of the generated library's filename		openapi-groovy
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
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
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
hideGenerationTimestamp	Hides the generation timestamp when files are generated.		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 false Various third party libraries as needed	false
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
prependFormOrBodyParameters	Add form or body parameters to the beginning of the parameter list.		false
scmConnection	SCM connection in generated pom.xml		scmgit@github.com:openapitools/openapi-generator.git
scmDeveloperConnection	SCM developer connection in generated pom.xml		scmgit@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
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/groovy
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

• ArrayList
• Boolean
• Date
• Double
• File
• Float
• Integer
• Long
• Map
• 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