mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-07 10:58:55 +00:00
0e1ce6bb63
* [docs] Updating docsite outputs to be browsable on Github as well * Fix links to other files Suffix `.md` was needed to make links works * [docs] Add clarification to differences between customization and templating docs * [docs] Collapsible side bar, scroll to top, minor enhancements
2.4 KiB
2.4 KiB
| title | sidebar_label |
|---|---|
| Config Options for kotlin-spring | kotlin-spring |
| Option | Description | Values | Default |
|---|---|---|---|
| sourceFolder | source folder for generated code | src/main/kotlin | |
| packageName | Generated artifact package name. | org.openapitools | |
| apiSuffix | suffix for api classes | Api | |
| groupId | Generated artifact package's organization (i.e. maven groupId). | org.openapitools | |
| artifactId | Generated artifact id (name of jar). | openapi-spring | |
| artifactVersion | Generated artifact's package version. | 1.0.0 | |
| enumPropertyNaming | Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' | camelCase | |
| serializationLibrary | What serialization library to use: 'moshi' (default), or 'gson' | moshi | |
| parcelizeModels | toggle "@Parcelize" for generated models | null | |
| serializableModel | boolean - toggle "implements Serializable" 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 (not compatible with reactive. enabling reactive will disable exceptionHandler ) | 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 | |
| reactive | use coroutines for reactive behavior | false | |
| interfaceOnly | Whether to generate only API interface stubs without the server files. | false | |
| library | library template (sub-template) |
|
spring-boot |