| Option | Description | Values | Default |
| apiSuffix | suffix for api classes | | Api |
| artifactId | Generated artifact id (name of jar). | | kotlin-server |
| artifactVersion | Generated artifact's package version. | | 1.0.0 |
| enumPropertyNaming | Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' | | camelCase |
| featureAutoHead | Automatically provide responses to HEAD requests for existing routes that have the GET verb defined. | | true |
| featureCORS | Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org. | | false |
| featureCompression | Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response. | | true |
| featureConditionalHeaders | Avoid sending content if client already has same content, by checking ETag or LastModified properties. | | false |
| featureHSTS | Avoid sending content if client already has same content, by checking ETag or LastModified properties. | | true |
| groupId | Generated artifact package's organization (i.e. maven groupId). | | org.openapitools |
| library | library template (sub-template) | - ktor
- ktor framework
| ktor |
| modelMutable | Create mutable models | | false |
| packageName | Generated artifact package name. | | org.openapitools.server |
| parcelizeModels | toggle "@Parcelize" for generated models | | null |
| serializableModel | boolean - toggle "implements Serializable" for generated models | | null |
| serializationLibrary | What serialization library to use: 'moshi' (default), or 'gson' | | moshi |
| 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 |
IMPORT MAPPING
| Type/Alias | Imports |
| BigDecimal | java.math.BigDecimal |
| Date | java.util.Date |
| DateTime | java.time.LocalDateTime |
| 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
- 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