openapi-generator/docs/generators/android.md

title	sidebar_label
Config Options for android	android

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

Option	Description	Values	Default
allowUnicodeIdentifiers	boolean, toggles whether unicode identifiers are allowed in names or not, default is false		false
androidBuildToolsVersion	buildToolsVersion version for use in the generated build.gradle		null
androidGradleVersion	gradleVersion version for use in the generated build.gradle		null
androidSdkVersion	compileSdkVersion version for use in the generated build.gradle		null
apiPackage	package for generated api classes		null
artifactId	artifactId for use in the generated build.gradle and pom.xml		null
artifactVersion	artifact version for use in the generated build.gradle and pom.xml		null
disallowAdditionalPropertiesIfNotPresent	If 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
ensureUniqueParams	Whether to ensure parameter names are unique in an operation (rename parameters that are not).		true
groupId	groupId for use in the generated build.gradle and pom.xml		null
invokerPackage	root package for generated code		null
legacyDiscriminatorBehavior	Set 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
library	library template (sub-template) to use	volley HTTP client: Volley 1.0.19 (default) httpclient HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be deprecated in the next major release.	null
modelPackage	package for generated models		null
prependFormOrBodyParameters	Add form or body parameters to the beginning of the parameter list.		false
serializableModel	boolean - toggle "implements Serializable" for generated models		false
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		null
useAndroidMavenGradlePlugin	A flag to toggle android-maven gradle plugin.		true

IMPORT MAPPING

Type/Alias	Imports
Array	java.util.List
ArrayList	java.util.ArrayList
BigDecimal	java.math.BigDecimal
Date	java.util.Date
File	java.io.File
HashMap	java.util.HashMap
List	java.util.*
Map	java.util.Map
Set	java.util.*
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
• apiinvoker
• assert
• authnames
• basepath
• boolean
• break
• byte
• case
• catch
• char
• class
• const
• continue
• default
• do
• double
• else
• enum
• extends
• final
• finally
• float
• for
• goto
• if
• implements
• import
• instanceof
• int
• interface
• localvarbuilder
• localvarcontenttype
• localvarcontenttypes
• localvarformparams
• localvarheaderparams
• localvarpath
• localvarpostbody
• localvarqueryparams
• localvarresponse
• long
• native
• new
• null
• object
• package
• private
• protected
• public
• return
• short
• static
• strictfp
• super
• switch
• synchronized
• this
• throw
• throws
• transient
• try
• void
• volatile
• while

FEATURE SET

Client Modification Feature

Name	Supported	Defined By
BasePath	✓	ToolingExtension
Authorizations	✗	ToolingExtension
UserAgent	✗	ToolingExtension
MockServer	✗	ToolingExtension

Data Type Feature

Name	Supported	Defined By
Custom	✗	OAS2,OAS3
Int32	✓	OAS2,OAS3
Int64	✓	OAS2,OAS3
Float	✓	OAS2,OAS3
Double	✓	OAS2,OAS3
Decimal	✓	ToolingExtension
String	✓	OAS2,OAS3
Byte	✓	OAS2,OAS3
Binary	✓	OAS2,OAS3
Boolean	✓	OAS2,OAS3
Date	✓	OAS2,OAS3
DateTime	✓	OAS2,OAS3
Password	✓	OAS2,OAS3
File	✓	OAS2
Array	✓	OAS2,OAS3
Maps	✓	ToolingExtension
CollectionFormat	✓	OAS2
CollectionFormatMulti	✓	OAS2
Enum	✓	OAS2,OAS3
ArrayOfEnum	✓	ToolingExtension
ArrayOfModel	✓	ToolingExtension
ArrayOfCollectionOfPrimitives	✓	ToolingExtension
ArrayOfCollectionOfModel	✓	ToolingExtension
ArrayOfCollectionOfEnum	✓	ToolingExtension
MapOfEnum	✓	ToolingExtension
MapOfModel	✓	ToolingExtension
MapOfCollectionOfPrimitives	✓	ToolingExtension
MapOfCollectionOfModel	✓	ToolingExtension
MapOfCollectionOfEnum	✓	ToolingExtension

Documentation Feature

Name	Supported	Defined By
Readme	✓	ToolingExtension
Model	✓	ToolingExtension
Api	✓	ToolingExtension

Global Feature

Name	Supported	Defined By
Host	✓	OAS2,OAS3
BasePath	✓	OAS2,OAS3
Info	✓	OAS2,OAS3
Schemes	✗	OAS2,OAS3
PartialSchemes	✓	OAS2,OAS3
Consumes	✓	OAS2
Produces	✓	OAS2
ExternalDocumentation	✓	OAS2,OAS3
Examples	✓	OAS2,OAS3
XMLStructureDefinitions	✗	OAS2,OAS3
MultiServer	✗	OAS3
ParameterizedServer	✗	OAS3
ParameterStyling	✗	OAS3
Callbacks	✗	OAS3
LinkObjects	✗	OAS3

Parameter Feature

Name	Supported	Defined By
Path	✓	OAS2,OAS3
Query	✓	OAS2,OAS3
Header	✓	OAS2,OAS3
Body	✓	OAS2
FormUnencoded	✓	OAS2
FormMultipart	✓	OAS2
Cookie	✗	OAS3

Schema Support Feature

Name	Supported	Defined By
Simple	✓	OAS2,OAS3
Composite	✓	OAS2,OAS3
Polymorphism	✓	OAS2,OAS3
Union	✗	OAS3

Security Feature

Name	Supported	Defined By
BasicAuth	✓	OAS2,OAS3
ApiKey	✓	OAS2,OAS3
OpenIDConnect	✗	OAS3
BearerToken	✗	OAS3
OAuth2_Implicit	✗	OAS2,OAS3
OAuth2_Password	✗	OAS2,OAS3
OAuth2_ClientCredentials	✗	OAS2,OAS3
OAuth2_AuthorizationCode	✗	OAS2,OAS3

Wire Format Feature

Name	Supported	Defined By
JSON	✓	OAS2,OAS3
XML	✓	OAS2,OAS3
PROTOBUF	✗	ToolingExtension
Custom	✗	OAS2,OAS3