openapi-generator/docs/generators/kotlin-spring.md
Jim Schubert 6fe9a52229 [feat][docs][website] Initial docusaurus based site (#1770)
* Iniital docusaurus based site

* Remove error about default local being used by String.format

* Change pinned users to represent global presence rather than alphabetical order pinning

* Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README)

* Add Font Awesome attribution footer

* Remove feature callout until it is completed

* Include NPM try it out section

* Improve "Getting Started" type docs

* Include new custom template documentation

* Updating templating and customization docs

* Add vendor extension docs

* Cleanup templating page(s).

* Move users to yaml file for easy edit.

* travis configuration, and baseUrl mods to image URLs

* [docs] Migrate FAQ, release summary  from wiki

FAQ has been split into multiple smaller documents to better categorize
and allow users to find what they're looking for (in docs folder or in
new website).

Release summary information (versioning strategy and cadence) has been
migrated from the Wiki and clarified a bit.

Also adds copy button for all code snippets in website.

* Copy current contributing/code of conduct to website

* [docs] Creating a new generator
2019-01-18 17:39:33 +08:00

2.0 KiB


id: generator-opts-server-kotlin-spring title: Config Options for kotlin-spring sidebar_label: kotlin-spring

Option Description Values Default
sourceFolder source folder for generated code src/main/kotlin
packageName Generated artifact package name. org.openapitools
groupId Generated artifact package's organization (i.e. maven groupId). org.openapitools
artifactId Generated artifact id (name of jar). null
artifactVersion Generated artifact's package version. 1.0.0
enumPropertyNaming Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' camelCase
parcelizeModels toggle "@Parcelize" for generated models null
title server title name or client service name OpenAPI Kotlin Spring
basePackage base package (invokerPackage) for generated code org.openapitools
serverPort configuration the port in which the sever is to run on 8080
modelPackage model package for generated code org.openapitools.model
apiPackage api package for generated code org.openapitools.api
exceptionHandler generate default global exception handlers true
gradleBuildFile generate a gradle build file using the Kotlin DSL true
swaggerAnnotations generate swagger annotations to go alongside controllers and models 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
serviceImplementation generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated false
useBeanValidation Use BeanValidation API annotations to validate data types true
library library template (sub-template) to use
spring-boot
Spring-boot Server application.
spring-boot