OpenAPI Generator

OpenAPI Generator

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

Config Options for kotlin-server

OptionDescriptionValuesDefault
apiSuffixsuffix for api classesApi
artifactIdGenerated artifact id (name of jar).kotlin-server
artifactVersionGenerated artifact's package version.1.0.0
enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
featureAutoHeadAutomatically provide responses to HEAD requests for existing routes that have the GET verb defined.true
featureCORSKtor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.false
featureCompressionAdds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.true
featureConditionalHeadersAvoid sending content if client already has same content, by checking ETag or LastModified properties.false
featureHSTSAvoid sending content if client already has same content, by checking ETag or LastModified properties.true
groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
librarylibrary template (sub-template)
ktor
ktor framework
ktor
modelMutableCreate mutable modelsfalse
packageNameGenerated artifact package name.org.openapitools.server
parcelizeModelstoggle "@Parcelize" for generated modelsnull
serializableModelboolean - toggle "implements Serializable" for generated modelsnull
serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
sourceFoldersource folder for generated codesrc/main/kotlin

IMPORT MAPPING

Type/AliasImports
BigDecimaljava.math.BigDecimal
Datejava.util.Date
DateTimejava.time.LocalDateTime
Filejava.io.File
LocalDatejava.time.LocalDate
LocalDateTimejava.time.LocalDateTime
LocalTimejava.time.LocalTime
Timestampjava.sql.Timestamp
URIjava.net.URI
UUIDjava.util.UUID

INSTANTIATION TYPES

Type/AliasInstantiated By
arraykotlin.arrayOf
listkotlin.arrayOf
mapkotlin.mapOf

LANGUAGE PRIMITIVES

  • kotlin.Array
  • kotlin.Boolean
  • kotlin.Byte
  • kotlin.ByteArray
  • kotlin.Char
  • kotlin.Double
  • kotlin.Float
  • kotlin.Int
  • kotlin.Long
  • kotlin.Short
  • kotlin.String
  • kotlin.collections.List
  • kotlin.collections.Map
  • kotlin.collections.Set

RESERVED WORDS

  • as
  • break
  • class
  • continue
  • do
  • else
  • false
  • for
  • fun
  • if
  • in
  • interface
  • is
  • null
  • object
  • package
  • return
  • super
  • this
  • throw
  • true
  • try
  • typealias
  • typeof
  • val
  • var
  • when
  • 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))