[Kotlin Server] Update Ktor to version 3

ktorio · Dec 4, 2024 · aa45441 · aa45441
1 parent 71ccc88
commit aa45441
Show file tree

Hide file tree

Showing 49 changed files with 187 additions and 203 deletions.
diff --git a/...enapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java b/...enapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
@@ -225,6 +225,11 @@ public void processOpts() {
             LOGGER.info("`library` option is empty. Default to {}", DEFAULT_LIBRARY);
         }
 
+        if (isKtor()) {
+            typeMapping.put("date-time", "kotlin.String");
+            typeMapping.put("DateTime", "kotlin.String");
+        }
+
         if (additionalProperties.containsKey(Constants.AUTOMATIC_HEAD_REQUESTS)) {
             setAutoHeadFeatureEnabled(convertPropertyToBooleanAndWriteBack(Constants.AUTOMATIC_HEAD_REQUESTS));
         } else {
@@ -353,6 +358,7 @@ public static class Constants {
         public static final String USE_MUTINY_DESC = "Whether to use Mutiny (should not be used with useCoroutines). This option is currently supported only when using jaxrs-spec library.";
         public static final String OMIT_GRADLE_WRAPPER = "omitGradleWrapper";
         public static final String OMIT_GRADLE_WRAPPER_DESC = "Whether to omit Gradle wrapper for creating a sub project.";
+        public static final String KOTLIN_SERIALIZATION = "kotlinSerialization";
     }
 
     @Override

diff --git a/modules/openapi-generator/src/main/resources/kotlin-server/data_class.mustache b/modules/openapi-generator/src/main/resources/kotlin-server/data_class.mustache
@@ -1,35 +1,21 @@
-{{#parcelizeModels}}
-import android.os.Parcelable
-import kotlinx.parcelize.Parcelize
-
-{{/parcelizeModels}}
-{{#serializableModel}}
-import java.io.Serializable
-{{/serializableModel}}
+import kotlinx.serialization.Serializable
 /**
  * {{{description}}}
 {{#vars}}
  * @param {{{name}}} {{{description}}}
 {{/vars}}
  */
-{{#parcelizeModels}}
-@Parcelize
-{{/parcelizeModels}}
+@Serializable
 {{#hasVars}}data {{/hasVars}}class {{classname}}(
 {{#requiredVars}}
 {{>data_class_req_var}}{{^-last}},
 {{/-last}}{{/requiredVars}}{{#hasRequired}}{{#hasOptional}},
 {{/hasOptional}}{{/hasRequired}}{{#optionalVars}}{{>data_class_opt_var}}{{^-last}},
 {{/-last}}{{/optionalVars}}
-) {{^serializableModel}}{{#parcelizeModels}} : Parcelable{{/parcelizeModels}}{{/serializableModel}}{{^parcelizeModels}}{{#serializableModel}}: Serializable {{/serializableModel}}{{/parcelizeModels}}{{#parcelizeModels}}{{#serializableModel}} : Parcelable, Serializable {{/serializableModel}}{{/parcelizeModels}}
+)
 {{#vendorExtensions.x-has-data-class-body}}
 {
 {{/vendorExtensions.x-has-data-class-body}}
-{{#serializableModel}}
-    companion object {
-        private const val serialVersionUID: Long = 123
-    }
-{{/serializableModel}}
 {{#hasEnums}}
     {{#vars}}
     {{#isEnum}}

diff --git a/.../openapi-generator/src/main/resources/kotlin-server/libraries/ktor/ApiKeyAuth.kt.mustache b/.../openapi-generator/src/main/resources/kotlin-server/libraries/ktor/ApiKeyAuth.kt.mustache
@@ -1,4 +1,4 @@
-package org.openapitools.server.infrastructure
+package {{packageName}}.infrastructure
 
 import io.ktor.http.auth.*
 import io.ktor.server.application.*

diff --git a/...les/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/AppMain.kt.mustache b/...les/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/AppMain.kt.mustache
@@ -1,7 +1,6 @@
 package {{packageName}}
 
 import io.ktor.server.application.*
-import io.ktor.serialization.gson.*
 import io.ktor.http.*
 {{#featureResources}}
 import io.ktor.server.resources.*
@@ -30,24 +29,19 @@ import java.util.concurrent.TimeUnit
 {{/featureMetrics}}
 import io.ktor.server.routing.*
 {{#hasAuthMethods}}
+{{#kotlinSerialization}}
+import io.ktor.serialization.kotlinx.json.json
+{{/kotlinSerialization}}
 import com.typesafe.config.ConfigFactory
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.apache.Apache
 import io.ktor.server.config.HoconApplicationConfig
 import io.ktor.server.auth.*
-import org.openapitools.server.infrastructure.*
+import {{packageName}}.infrastructure.*
 {{/hasAuthMethods}}
 {{#generateApis}}{{#apiInfo}}{{#apis}}import {{apiPackage}}.{{classname}}
 {{/apis}}{{/apiInfo}}{{/generateApis}}
 
-{{#hasAuthMethods}}
-internal val settings = HoconApplicationConfig(ConfigFactory.defaultApplication(HTTP::class.java.classLoader))
-
-object HTTP {
-    val client = HttpClient(Apache)
-}
-{{/hasAuthMethods}}
-
 fun Application.main() {
     install(DefaultHeaders)
     {{#featureMetrics}}
@@ -62,7 +56,9 @@ fun Application.main() {
     {{/featureMetrics}}
 {{#generateApis}}
     install(ContentNegotiation) {
-        register(ContentType.Application.Json, GsonConverter())
+    {{#kotlinSerialization}}
+        json()
+    {{/kotlinSerialization}}
     }
     {{#featureAutoHead}}
     install(AutoHeadResponse) // see https://ktor.io/docs/autoheadresponse.html
@@ -125,7 +121,7 @@ fun Application.main() {
     {{/authMethods}}
     }
     {{/hasAuthMethods}}
-    install(Routing) {
+    routing {
     {{#apiInfo}}
     {{#apis}}
     {{#operations}}
@@ -134,6 +130,5 @@ fun Application.main() {
     {{/apis}}
     {{/apiInfo}}
     }
-
 {{/generateApis}}
 }
diff --git a/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/Paths.kt.mustache b/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/Paths.kt.mustache
@@ -18,10 +18,10 @@ object Paths {
      {{#allParams}}* @param {{paramName}} {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
      {{/allParams}}*/
     {{#hasParams}}
-    @Serializable @Resource("{{{path}}}") class {{operationId}}({{#allParams}}val {{paramName}}: {{{dataType}}}{{^required}}? = null{{/required}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
+    @Resource("{{{path}}}") class {{operationId}}({{#pathParams}}val {{paramName}}: {{{dataType}}}{{^required}}? = null{{/required}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^-last}}, {{/-last}}{{/pathParams}})
     {{/hasParams}}
     {{^hasParams}}
-    @Serializable @Resource("{{{path}}}") class {{operationId}}
+    @Resource("{{{path}}}") class {{operationId}}
     {{/hasParams}}
 
     {{/operation}}

diff --git a/...les/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/_principal.mustache b/...les/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/_principal.mustache
@@ -1,10 +1,10 @@
 {{#authMethods}}
 {{#isBasicBasic}}
-val principal = call.authentication.principal<UserIdPrincipal>()!!
+val principal = call.authentication.principal<UserIdPrincipal>()
 {{/isBasicBasic}}{{^isBasicBasic}}{{#isApiKey}}
-val principal = call.authentication.principal<ApiPrincipal>()!!
+val principal = call.authentication.principal<ApiPrincipal>()
 {{/isApiKey}}{{^isApiKey}}{{#isOAuth}}
-val principal = call.authentication.principal<OAuthAccessTokenResponse>()!!
+val principal = call.authentication.principal<OAuthAccessTokenResponse>()
 {{/isOAuth}}{{^isOAuth}}
 val principal = null!!
 {{/isOAuth}}{{/isApiKey}}{{/isBasicBasic}}

diff --git a/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/_response.mustache b/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/_response.mustache
@@ -2,7 +2,7 @@ val exampleContentType = "{{{contentType}}}"
 val exampleContentString = """{{&example}}"""
 
 when (exampleContentType) {
-    "application/json" -> call.respond(gson.fromJson(exampleContentString, empty::class.java))
+    "application/json" -> call.respondText(exampleContentType, ContentType.Application.Json)
     "application/xml" -> call.respondText(exampleContentString, ContentType.Text.Xml)
     else -> call.respondText(exampleContentString)
 }
diff --git a/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/api.mustache b/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/api.mustache
@@ -1,7 +1,6 @@
 {{>licenseInfo}}
 package {{apiPackage}}
 
-import com.google.gson.Gson
 import io.ktor.http.*
 import io.ktor.server.application.*
 import io.ktor.server.auth.*
@@ -23,7 +22,6 @@ import {{packageName}}.infrastructure.ApiPrincipal
 
 {{#operations}}
 fun Route.{{classname}}() {
-    val gson = Gson()
     val empty = mutableMapOf<String, Any?>()
 
 {{#operation}}

diff --git a/...enapi-generator/src/main/resources/kotlin-server/libraries/ktor/build.gradle.kts.mustache b/...enapi-generator/src/main/resources/kotlin-server/libraries/ktor/build.gradle.kts.mustache
@@ -7,7 +7,8 @@ version = "{{artifactVersion}}"
 
 plugins {
     kotlin("jvm") version "2.0.20"
-    id("io.ktor.plugin") version "2.3.12"
+    id("io.ktor.plugin") version "3.0.2"
+    kotlin("plugin.serialization") version "2.0.20"
 }
 
 application {
@@ -35,7 +36,7 @@ dependencies {
 {{/featureAutoHead}}
     implementation("io.ktor:ktor-server-default-headers")
     implementation("io.ktor:ktor-server-content-negotiation")
-    implementation("io.ktor:ktor-serialization-gson")
+    implementation("io.ktor:ktor-serialization-kotlinx-json")
 {{#featureResources}}
     implementation("io.ktor:ktor-server-resources")
 {{/featureResources}}

diff --git a/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/gradle.properties b/modules/openapi-generator/src/main/resources/kotlin-server/libraries/ktor/gradle.properties
@@ -1,4 +1,4 @@
 kotlin.code.style=official
-ktor_version=2.3.12
+ktor_version=3.0.2
 kotlin_version=2.0.20
 logback_version=1.4.14
diff --git a/samples/server/petstore/kotlin-server-modelMutable/build.gradle.kts b/samples/server/petstore/kotlin-server-modelMutable/build.gradle.kts
@@ -7,7 +7,8 @@ version = "1.0.0"
 
 plugins {
     kotlin("jvm") version "2.0.20"
-    id("io.ktor.plugin") version "2.3.12"
+    id("io.ktor.plugin") version "3.0.2"
+    kotlin("plugin.serialization") version "2.0.20"
 }
 
 application {
@@ -29,7 +30,7 @@ dependencies {
     implementation("io.ktor:ktor-server-auto-head-response")
     implementation("io.ktor:ktor-server-default-headers")
     implementation("io.ktor:ktor-server-content-negotiation")
-    implementation("io.ktor:ktor-serialization-gson")
+    implementation("io.ktor:ktor-serialization-kotlinx-json")
     implementation("io.ktor:ktor-server-resources")
     implementation("io.ktor:ktor-server-hsts")
     implementation("io.ktor:ktor-server-compression")

diff --git a/samples/server/petstore/kotlin-server-modelMutable/gradle.properties b/samples/server/petstore/kotlin-server-modelMutable/gradle.properties
@@ -1,4 +1,4 @@
 kotlin.code.style=official
-ktor_version=2.3.12
+ktor_version=3.0.2
 kotlin_version=2.0.20
 logback_version=1.4.14
diff --git a/...er/petstore/kotlin-server-modelMutable/src/main/kotlin/org/openapitools/server/AppMain.kt b/...er/petstore/kotlin-server-modelMutable/src/main/kotlin/org/openapitools/server/AppMain.kt
@@ -1,7 +1,6 @@
 package org.openapitools.server
 
 import io.ktor.server.application.*
-import io.ktor.serialization.gson.*
 import io.ktor.http.*
 import io.ktor.server.resources.*
 import io.ktor.server.plugins.autohead.*
@@ -24,12 +23,6 @@ import org.openapitools.server.apis.StoreApi
 import org.openapitools.server.apis.UserApi
 
 
-internal val settings = HoconApplicationConfig(ConfigFactory.defaultApplication(HTTP::class.java.classLoader))
-
-object HTTP {
-    val client = HttpClient(Apache)
-}
-
 fun Application.main() {
     install(DefaultHeaders)
     install(DropwizardMetrics) {
@@ -41,7 +34,6 @@ fun Application.main() {
         reporter.start(10, TimeUnit.SECONDS)
     }
     install(ContentNegotiation) {
-        register(ContentType.Application.Json, GsonConverter())
     }
     install(AutoHeadResponse) // see https://ktor.io/docs/autoheadresponse.html
     install(Compression, ApplicationCompressionConfiguration()) // see https://ktor.io/docs/compression.html
@@ -66,10 +58,9 @@ fun Application.main() {
             }
         }
     }
-    install(Routing) {
+    routing {
         PetApi()
         StoreApi()
         UserApi()
     }
-
 }