Documentation for the java-micronaut-client Generator

METADATA

PropertyValueNotes
generator namejava-micronaut-clientpass this to the generate command after -g
generator stabilityBETA
generator typeCLIENT
generator languageJava
generator default templating enginemustache
helpTxtGenerates a Java Micronaut Client.

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
apiPackagepackage for generated api classesorg.openapitools.api
applicationNameMicronaut application name (Defaults to the artifactId value)openapi-micronaut-client
artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-micronaut-client
artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
booleanGetterPrefixSet booleanGetterPrefixget
buildSpecify for which build tool to generate files
gradle
Gradle configuration is generated for the project
all
Both Gradle and Maven configurations are generated
maven
Maven configuration is generated for the project
all
configureAuthConfigure all the authorization methods as specified in the filefalse
dateFormatSpecify the format pattern of date as a stringnull
dateLibraryOption. Date library to use
java8-localdatetime
Java 8 using LocalDateTime (for legacy app only)
java8
Java 8 native JSR310 (preferred for jdk 1.8+)
java8
datetimeFormatSpecify the format pattern of date-time as a stringnull
developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
generateOperationOnlyForFirstTagWhen false, the operation method will be duplicated in each of the tags if multiple tags are assigned to this operation. If true, each operation will be generated only once in the first assigned tag.false
generateSwaggerAnnotationsSpecify if you want to generate swagger annotations and which version
swagger2
Use io.swagger.core.v3:swagger-annotations for annotating operations and schemas
true
Equivalent to "swagger2"
false
Do not generate swagger annotations
swagger1
Use io.swagger:swagger-annotations for annotating operations and schemas
false
groupIdgroupId in generated pom.xmlorg.openapitools
hideGenerationTimestampHides the generation timestamp when files are generated.false
ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
invokerPackageroot package for generated codeorg.openapitools
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
licenseNameThe name of the licenseUnlicense
licenseUrlThe URL of the licensehttp://unlicense.org
micronautVersionMicronaut version, only >=3.0.0 versions are supported3.4.3
modelPackagepackage for generated modelsorg.openapitools.model
openApiNullableEnable OpenAPI Jackson Nullable librarytrue
parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
reactiveMake the responses use Reactor Mono as wrappertrue
requiredPropertiesInConstructorAllow only to create models with all the required properties provided in constructortrue
scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
snapshotVersionUses a SNAPSHOT version.
true
Use a SnapShot Version
false
Use a Release Version
null
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
sourceFoldersource folder for generated codesrc/main/java
testSpecify which test tool to generate files for
junit
Use JUnit as test tool
spock
Use Spock as test tool
junit
testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
titleClient service namenull
useBeanValidationUse BeanValidation API annotationstrue
useOptionalUse Optional container for optional parametersfalse
visitableGenerate visitor for subtypes with a discriminatorfalse
withXmlwhether 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
wrapInHttpResponseWrap the response in HttpResponse objectfalse

SUPPORTED VENDOR EXTENSIONS

Extension nameDescriptionApplicable forDefault value
x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
x-implementsAbility to specify interfaces that model must implementsMODELempty array
x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
x-tagsSpecify multiple swagger tags for operationOPERATIONnull
x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
x-class-extra-annotationList of custom annotations to be added to modelMODELnull
x-field-extra-annotationList of custom annotations to be added to propertyFIELDnull

IMPORT MAPPING

Type/AliasImports
Arrayjava.util.List
ArrayListjava.util.ArrayList
BigDecimaljava.math.BigDecimal
Datejava.util.Date
DateTimeorg.joda.time.*
Filejava.io.File
HashMapjava.util.HashMap
LinkedHashSetjava.util.LinkedHashSet
Listjava.util.*
LocalDateorg.joda.time.*
LocalDateTimeorg.joda.time.*
LocalTimeorg.joda.time.*
Mapjava.util.Map
Setjava.util.*
Timestampjava.sql.Timestamp
URIjava.net.URI
UUIDjava.util.UUID

INSTANTIATION TYPES

Type/AliasInstantiated By
arrayArrayList
mapHashMap
setLinkedHashSet

LANGUAGE PRIMITIVES

  • Boolean
  • Double
  • Float
  • Integer
  • Long
  • Object
  • String
  • boolean
  • byte[]

RESERVED WORDS

  • abstract
  • apiclient
  • apiexception
  • apiresponse
  • application
  • assert
  • authorization
  • body
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • client
  • configuration
  • const
  • continue
  • cookie
  • default
  • do
  • double
  • else
  • enum
  • extends
  • file
  • final
  • finally
  • float
  • for
  • format
  • goto
  • header
  • if
  • implements
  • import
  • instanceof
  • int
  • interface
  • list
  • localreturntype
  • localvaraccept
  • localvaraccepts
  • localvarauthnames
  • localvarcollectionqueryparams
  • localvarcontenttype
  • localvarcontenttypes
  • localvarcookieparams
  • localvarformparams
  • localvarheaderparams
  • localvarpath
  • localvarpostbody
  • localvarqueryparams
  • long
  • native
  • new
  • null
  • object
  • package
  • pathvariable
  • private
  • protected
  • public
  • queryparam
  • queryvalue
  • return
  • short
  • static
  • strictfp
  • stringutil
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • transient
  • try
  • void
  • volatile
  • while

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension
MockServerToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
Uuid
ArrayOAS2,OAS3
NullOAS3
AnyTypeOAS2,OAS3
ObjectOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3
allOfOAS2,OAS3
anyOfOAS3
oneOfOAS3
notOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3
Last updated on by jiangyuan