openapi-generator/docs/generators/n4js.md

title
Documentation for the n4js Generator

METADATA

Property	Value	Notes
generator name	n4js	pass this to the generate command after -g
generator stability	BETA
generator type	CLIENT
generator language	Java
generator default templating engine	mustache
helpTxt	Generates a n4js client.

CONFIG OPTIONS

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

Option	Description	Values	Default
apiNamePrefix	Prefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.		null
apiPackage	package for generated api classes		null
checkRequiredParamsNotNull	Iff true null-checks are performed for required parameters.		null
checkSuperfluousBodyProps	Iff true a new copy of the given body object is transmitted. This copy only contains those properties defined in its model specification.		null
generateDefaultApiExecuter	Iff true a default implementation of the api executer interface is generated.		null
modelPackage	package for generated models		null

IMPORT MAPPING

Type/Alias	Imports

INSTANTIATION TYPES

Type/Alias	Instantiated By

LANGUAGE PRIMITIVES

• Array
• Error
• Object
• String
• any
• any+
• boolean
• int
• number
• object
• string

RESERVED WORDS

• abstract
• await
• boolean
• break
• byte
• case
• catch
• char
• class
• const
• continue
• debugger
• default
• delete
• do
• double
• else
• enum
• export
• extends
• false
• final
• finally
• float
• for
• formParams
• function
• goto
• headerParams
• if
• implements
• import
• in
• instanceof
• int
• interface
• let
• long
• native
• new
• null
• package
• private
• protected
• public
• queryParameters
• requestOptions
• return
• short
• static
• super
• switch
• synchronized
• this
• throw
• transient
• true
• try
• typeof
• useFormData
• var
• varLocalDeferred
• varLocalPath
• void
• volatile
• while
• with
• yield

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
Uuid	✗
Array	✓	OAS2,OAS3
Null	✗	OAS3
AnyType	✗	OAS2,OAS3
Object	✓	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
allOf	✗	OAS2,OAS3
anyOf	✗	OAS3
oneOf	✗	OAS3
not	✗	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