loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-31 05:50:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/docs/generators/kotlin-spring.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

4.4 KiB
Raw Blame History

title sidebar_label
Config Options for kotlin-spring kotlin-spring
Option Description Values Default
apiPackage api package for generated code org.openapitools.api
apiSuffix suffix for api classes Api
artifactId Generated artifact id (name of jar). openapi-spring
artifactVersion Generated artifact's package version. 1.0.0
basePackage base package (invokerPackage) for generated code org.openapitools
delegatePattern Whether to generate the server files using the delegate pattern false
enumPropertyNaming Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' camelCase
exceptionHandler generate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler ) true
gradleBuildFile generate a gradle build file using the Kotlin DSL true
groupId Generated artifact package's organization (i.e. maven groupId). org.openapitools
interfaceOnly Whether to generate only API interface stubs without the server files. false
library library template (sub-template)
spring-boot
Spring-boot Server application.
 spring-boot
modelMutable Create mutable models false
modelPackage model package for generated code org.openapitools.model
packageName Generated artifact package name. org.openapitools
parcelizeModels toggle "@Parcelize" for generated models null
reactive use coroutines for reactive behavior false
serializableModel boolean - toggle "implements Serializable" for generated models null
serializationLibrary What serialization library to use: 'moshi' (default), or 'gson' moshi
serverPort configuration the port in which the sever is to run on 8080
serviceImplementation generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated false
serviceInterface generate 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 pattern false
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. null
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. null
sourceFolder source folder for generated code src/main/kotlin
swaggerAnnotations generate swagger annotations to go alongside controllers and models false
title server title name or client service name OpenAPI Kotlin Spring
useBeanValidation Use BeanValidation API annotations to validate data types true

IMPORT MAPPING

Type/Alias Imports
BigDecimal java.math.BigDecimal
Date java.time.LocalDate
DateTime java.time.OffsetDateTime
File java.io.File
LocalDate java.time.LocalDate
LocalDateTime java.time.LocalDateTime
LocalTime java.time.LocalTime
Timestamp java.sql.Timestamp
URI java.net.URI
UUID java.util.UUID

INSTANTIATION TYPES

Type/Alias Instantiated By
array kotlin.arrayOf
list kotlin.arrayOf
map kotlin.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