OpenAPI Generator

OpenAPI Generator

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

Config Options for kotlin

OptionDescriptionValuesDefault
sourceFoldersource folder for generated codesrc/main/kotlin
packageNameGenerated artifact package name.org.openapitools.client
apiSuffixsuffix for api classesApi
groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
artifactIdGenerated artifact id (name of jar).kotlin-client
artifactVersionGenerated artifact's package version.1.0.0
enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
parcelizeModelstoggle "@Parcelize" for generated modelsnull
serializableModelboolean - toggle "implements Serializable" for generated modelsnull
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
modelMutableCreate mutable modelsfalse
dateLibraryOption. Date library to use
string
String
java8
Java 8 native JSR310 (jvm only)
threetenbp
Threetenbp (jvm only)
java8
collectionTypeOption. Collection type to use
array
kotlin.Array
list
kotlin.collections.List
array
libraryLibrary template (sub-template) to use
jvm-okhttp4
[DEFAULT] Platform: Java Virtual Machine. HTTP client: OkHttp 4.2.0 (Android 5.0+ and Java 8+). JSON processing: Moshi 1.8.0.
jvm-okhttp3
Platform: Java Virtual Machine. HTTP client: OkHttp 3.12.4 (Android 2.3+ and Java 7+). JSON processing: Moshi 1.8.0.
jvm-retrofit2
Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.
multiplatform
Platform: Kotlin multiplatform. HTTP client: Ktor 1.2.4. JSON processing: Kotlinx Serialization: 0.12.0.
jvm-okhttp4
requestDateConverterJVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)
toJson
Date formater option using a json converter.
toString
[DEFAULT] Use the 'toString'-method of the date-time object to retrieve the related string representation.
toString
Last updated on 12/20/2019
OpenAPI Generator
Docs
Customizing GeneratorsWorkflow Integrations
Community
User ShowcaseStack OverflowChat RoomTwitter
More
BlogGitHub RepoStar
Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))