loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/javascript.md
Jim Schubert aa7cd4f5af
[docs] Upgrade to Docusaurus 2 (#5271) 
* [docs] Upgrade to Docusaurus 2

Due to formatting issues with Docusaurus 1 and code blocks, and upcoming
4.3 and 5.0 releases, this is an upgrade to have more control over
formatting and other functionality.

This adds behavior to have light/dark themes.

As a consequence of upgrading, columnar format on ul element in
generated generator docs had to be moved to css. This will not impact
users viewing the markdown on GitHub because it didn't display the
column format.

This upgrade should improve syntax highlighting and performance.

* Fix user page layout, choose theme with clear diff colors
2020-02-11 21:22:58 +08:00

6.5 KiB
Raw Blame History

title sidebar_label
Config Options for javascript javascript
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiPackage package for generated api classes null
emitJSDoc generate JSDoc comments true
emitModelMethods generate getters and setters for model properties false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
invokerPackage root package for generated code null
licenseName name of the license the project uses (Default: using info.license.name) null
modelPackage package for generated models null
modelPropertyNaming Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name camelCase
moduleName module name for AMD, Node or globals (Default: generated from <projectName>) null
npmRepository Use this property to set an url your private npmRepo in the package.json null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
projectDescription description of the project (Default: using info.description or "Client library of <projectName>") null
projectName name of the project (Default: generated from info.title or "openapi-js-client") null
projectVersion version of the project (Default: using info.version or "1.0.0") 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
useES6 use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6. true
useInheritance use JavaScript prototype chains & delegation for inheritance true
usePromises use Promises as return values from the client API, instead of superagent callbacks false

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By
array Array
list Array
map Object

LANGUAGE PRIMITIVES

  • Array
  • Blob
  • Boolean
  • Date
  • File
  • Number
  • Object
  • String

RESERVED WORDS

  • abstract
  • arguments
  • array
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • const
  • continue
  • date
  • debugger
  • default
  • delete
  • do
  • double
  • else
  • enum
  • eval
  • export
  • extends
  • false
  • final
  • finally
  • float
  • for
  • function
  • goto
  • hasownproperty
  • if
  • implements
  • import
  • in
  • infinity
  • instanceof
  • int
  • interface
  • isfinite
  • isnan
  • isprototypeof
  • let
  • long
  • math
  • nan
  • native
  • new
  • null
  • number
  • object
  • package
  • private
  • protected
  • prototype
  • public
  • return
  • short
  • static
  • string
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • tostring
  • transient
  • true
  • try
  • typeof
  • undefined
  • valueof
  • var
  • void
  • volatile
  • while
  • with
  • yield

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ✗ ToolingExtension
Authorizations ✗ ToolingExtension
UserAgent ✗ 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