| additionalModelTypeAnnotations |
Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows) |
|
null |
| apiSuffix |
suffix for api classes |
|
Api |
| artifactId |
Generated artifact id (name of jar). |
|
kotlin-client |
| artifactVersion |
Generated artifact's package version. |
|
1.0.0 |
| collectionType |
Option. Collection type to use |
- array
- kotlin.Array
- list
- kotlin.collections.List
|
list |
| dateLibrary |
Option. Date library to use |
- threetenbp-localdatetime
- Threetenbp - Backport of JSR310 (jvm only, for legacy app only)
- kotlinx-datetime
- kotlinx-datetime (preferred for multiplatform)
- string
- String
- java8-localdatetime
- Java 8 native JSR310 (jvm only, for legacy app only)
- java8
- Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)
- threetenbp
- Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)
|
java8 |
| enumPropertyNaming |
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' |
|
camelCase |
| generateRoomModels |
Generate Android Room database models in addition to API models (JVM Volley library only) |
|
false |
| groupId |
Generated artifact package's organization (i.e. maven groupId). |
|
org.openapitools |
| idea |
Add IntellJ Idea plugin and mark Kotlin main and test folders as source folders. |
|
false |
| library |
Library template (sub-template) to use |
- jvm-ktor
- Platform: Java Virtual Machine. HTTP client: Ktor 1.6.7. JSON processing: Gson, Jackson (default).
- 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. (DEPRECATED: this option will be remove in 7.x release)
- jvm-spring-webclient
- Platform: Java Virtual Machine. HTTP: Spring 5 (or 6 with useSpringBoot3 enabled) WebClient. JSON processing: Jackson.
- jvm-retrofit2
- Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.
- multiplatform
- Platform: Kotlin multiplatform. HTTP client: Ktor 1.6.7. JSON processing: Kotlinx Serialization: 1.2.1.
- jvm-volley
- Platform: JVM for Android. HTTP client: Volley 1.2.1. JSON processing: gson 2.8.9
- jvm-vertx
- Platform: Java Virtual Machine. HTTP client: Vert.x Web Client. JSON processing: Moshi, Gson or Jackson.
|
jvm-okhttp4 |
| modelMutable |
Create mutable models |
|
false |
| moshiCodeGen |
Whether to enable codegen with the Moshi library. Refer to the official Moshi doc for more info. |
|
false |
| nullableReturnType |
Nullable return type |
|
false |
| omitGradlePluginVersions |
Whether to declare Gradle plugin versions in build files. |
|
false |
| omitGradleWrapper |
Whether to omit Gradle wrapper for creating a sub project. |
|
false |
| packageName |
Generated artifact package name. |
|
org.openapitools.client |
| parcelizeModels |
toggle "@Parcelize" for generated models |
|
null |
| requestDateConverter |
JVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter) |
- toJson
- [DEFAULT] Date formatter option using a json converter.
- toString
- Use the 'toString'-method of the date-time object to retrieve the related string representation.
|
toJson |
| serializableModel |
boolean - toggle "implements Serializable" for generated models |
|
null |
| serializationLibrary |
What serialization library to use: 'moshi' (default), or 'gson' or 'jackson' or 'kotlinx_serialization' |
|
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 |
| supportAndroidApiLevel25AndBelow |
[WARNING] This flag will generate code that has a known security vulnerability. It uses kotlin.io.createTempFile instead of java.nio.file.Files.createTempFile in order to support Android API level 25 and bellow. For more info, please check the following links https://github.com/OpenAPITools/openapi-generator/security/advisories/GHSA-23x4-m842-fmwf, #9284 |
|
false |
| useCoroutines |
Whether to use the Coroutines adapter with the retrofit2 library. |
|
false |
| useRxJava3 |
Whether to use the RxJava3 adapter with the retrofit2 library. |
|
false |
| useSettingsGradle |
Whether the project uses settings.gradle. |
|
false |
| useSpringBoot3 |
Whether to use the Spring Boot 3 with the jvm-spring-webclient library. |
|
false |