OpenAPI Generator

OpenAPI Generator

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

Config Options for kotlin-spring

OptionDescriptionValuesDefault
apiPackageapi package for generated codeorg.openapitools.api
apiSuffixsuffix for api classesApi
artifactIdGenerated artifact id (name of jar).openapi-spring
artifactVersionGenerated artifact's package version.1.0.0
basePackagebase package (invokerPackage) for generated codeorg.openapitools
delegatePatternWhether to generate the server files using the delegate patternfalse
enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
exceptionHandlergenerate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )true
gradleBuildFilegenerate a gradle build file using the Kotlin DSLtrue
groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
interfaceOnlyWhether to generate only API interface stubs without the server files.false
librarylibrary template (sub-template)
spring-boot
Spring-boot Server application.
spring-boot
modelMutableCreate mutable modelsfalse
modelPackagemodel package for generated codeorg.openapitools.model
packageNameGenerated artifact package name.org.openapitools
parcelizeModelstoggle "@Parcelize" for generated modelsnull
reactiveuse coroutines for reactive behaviorfalse
serializableModelboolean - toggle "implements Serializable" for generated modelsnull
serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
serverPortconfiguration the port in which the sever is to run on8080
serviceImplementationgenerate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generatedfalse
serviceInterfacegenerate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap patternfalse
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
swaggerAnnotationsgenerate swagger annotations to go alongside controllers and modelsfalse
titleserver title name or client service nameOpenAPI Kotlin Spring
useBeanValidationUse BeanValidation API annotations to validate data typestrue

IMPORT MAPPING

Type/AliasImports
BigDecimaljava.math.BigDecimal
Datejava.time.LocalDate
DateTimejava.time.OffsetDateTime
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

  • ApiClient
  • ApiException
  • ApiResponse
  • 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))