OpenAPI Generator

OpenAPI Generator

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

Config Options for bash

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
apiKeyAuthEnvironmentVariableName of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')false
basicAuthEnvironmentVariableName of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')null
curlOptionsDefault cURL optionsnull
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
generateBashCompletionWhether to generate the Bash completion scriptfalse
generateZshCompletionWhether to generate the Zsh completion scriptfalse
hostEnvironmentVariableName of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')null
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
processMarkdownConvert all Markdown Markup into terminal formattingfalse
scriptNameThe name of the script that will be generated (e.g. petstore-cli)null
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

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
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

LANGUAGE PRIMITIVES

  • array
  • binary
  • boolean
  • float
  • integer
  • map
  • string

RESERVED WORDS

  • case
  • do
  • done
  • elif
  • else
  • esac
  • fi
  • for
  • function
  • if
  • in
  • select
  • then
  • time
  • until
  • while
Last updated on 1/20/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))