OpenAPI Generator

OpenAPI Generator

  • Get Started
  • Generators
  • Roadmap
  • Team
  • FAQ
  • Blog

Config Options for typescript-node

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
supportsES6Generate code that conforms to ES6.false

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By
arrayArray

LANGUAGE PRIMITIVES

  • Array
  • Boolean
  • Buffer
  • Date
  • Double
  • Error
  • File
  • Float
  • Integer
  • Long
  • Map
  • Object
  • ReadStream
  • RequestDetailedFile
  • RequestFile
  • String
  • any
  • boolean
  • 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
Last updated on 1/31/2020
  • IMPORT MAPPING
  • INSTANTIATION TYPES
  • LANGUAGE PRIMITIVES
  • RESERVED WORDS
OpenAPI Generator
Docs
Customizing GeneratorsWorkflow Integrations
Community
User ShowcaseStack OverflowChat RoomTwitter
More
BlogGitHub RepoStar
Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))