Add documentation for 3.4.0

cfg/glossary.xml

@@ -4,4 +4,7 @@
     <term name="query_string">
         A part of a URL that assigns values to specified parameters and starts with the ? character.
     </term>
+    <term name="classpath">
+        A list of locations where the JVM looks for user classes and resources.
+    </term>
 </terms>

codeSnippets/build.gradle

@@ -16,7 +16,7 @@ buildscript {
         }
         repositories {
             mavenLocal()
-            maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
+            maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") }
         }
 
         configurations.classpath {
@@ -70,14 +70,14 @@ allprojects {
         kotlin_version = rootProject.properties['kotlin_snapshot_version']
         repositories {
             mavenLocal()
-            maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
+            maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") }
         }
     }
 
     repositories {
         mavenCentral()
         maven {
-            url "https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev"
+            url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev")
         }
     }
 }
@@ -89,7 +89,7 @@ def ktorRepositoryDir = file("$buildDir/m2")
 if (ktorRepositoryDir.exists()) {
     allprojects {
         repositories {
-            maven { url ktorRepositoryDir.absolutePath }
+            maven { url = uri(ktorRepositoryDir.absolutePath) }
         }
     }
 } else {

codeSnippets/gradle.properties

@@ -4,9 +4,11 @@ kotlin.code.style = official
 kotlin.native.binary.memoryModel = experimental
 # gradle configuration
 org.gradle.configureondemand = false
+kotlin.mpp.applyDefaultHierarchyTemplate=false
+org.gradle.java.installations.auto-download=false
 # versions
-kotlin_version = 2.2.20
-ktor_version = 3.3.3
+kotlin_version = 2.3.0
+ktor_version = 3.4.0
 kotlinx_coroutines_version = 1.10.1
 kotlinx_serialization_version = 1.8.0
 kotlin_css_version = 1.0.0-pre.721

codeSnippets/settings.gradle.kts

@@ -161,6 +161,8 @@ module("snippets", "tutorial-server-restful-api")
 module("snippets", "tutorial-server-websockets")
 module("snippets", "tutorial-server-docker-compose")
 module("snippets", "htmx-integration")
+module("snippets", "server-http-request-lifecycle")
+module("snippets", "openapi-spec-gen")
 
 if(!System.getProperty("os.name").startsWith("Windows")) {
     module("snippets", "embedded-server-native")

codeSnippets/snippets/_misc_client/Apache5Create.kt

@@ -11,11 +11,21 @@ val client = HttpClient(Apache5) {
         socketTimeout = 10_000
         connectTimeout = 10_000
         connectionRequestTimeout = 20_000
+
+        // Configure the Apache5 ConnectionManager
+        configureConnectionManager {
+            setMaxConnPerRoute(1_000)
+            setMaxConnTotal(2_000)
+        }
+
+        // Customize the underlying Apache client for other settings
         customizeClient {
             // this: HttpAsyncClientBuilder
             setProxy(HttpHost("127.0.0.1", 8080))
             // ...
         }
+
+        // Customize per-request settings
         customizeRequest {
             // this: RequestConfig.Builder
         }

codeSnippets/snippets/_misc_client/InstallOrReplacePlugin.kt

@@ -0,0 +1,8 @@
+import io.ktor.client.*
+import io.ktor.client.engine.cio.*
+
+val client = HttpClient(CIO) {
+    installOrReplace(ContentNegotiation) {
+        // ...
+    }
+}

codeSnippets/snippets/_misc_client/OkHttpConfig.kt

@@ -13,5 +13,6 @@ val client = HttpClient(OkHttp) {
         addNetworkInterceptor(interceptor)
 
         preconfigured = okHttpClientInstance
+        duplexStreamingEnabled = true // Only available for HTTP/2 connections
     }
 }

codeSnippets/snippets/auth-oauth-google/src/main/kotlin/com/example/oauth/google/Application.kt

@@ -54,6 +54,13 @@ fun Application.main(httpClient: HttpClient = applicationHttpClient) {
                     }
                 )
             }
+            fallback = { cause ->
+                if (cause is OAuth2RedirectError) {
+                    respondRedirect("/login-after-fallback")
+                } else {
+                    respond(HttpStatusCode.Forbidden, cause.message)
+                }
+            }
             client = httpClient
         }
     }
@@ -101,6 +108,9 @@ fun Application.main(httpClient: HttpClient = applicationHttpClient) {
                 call.respondText("Hello, ${userInfo.name}!")
             }
         }
+        get("/login-after-fallback") {
+            call.respondText("Redirected after fallback")
+        }
     }
 }
 

codeSnippets/snippets/aws-elastic-beanstalk/build.gradle.kts

@@ -3,7 +3,7 @@ val logback_version: String by project
 plugins {
     application
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 application {

codeSnippets/snippets/deployment-ktor-plugin/build.gradle.kts

@@ -4,7 +4,7 @@ val logback_version: String by project
 plugins {
     application
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 application {

codeSnippets/snippets/engine-main-custom-environment/build.gradle.kts

@@ -4,7 +4,7 @@ val logback_version: String by project
 plugins {
     application
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 application {

codeSnippets/snippets/forwarded-header/build.gradle.kts

@@ -4,7 +4,7 @@ val logback_version: String by project
 plugins {
     application
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 application {

codeSnippets/snippets/full-stack-task-manager/gradle/libs.versions.toml

@@ -16,7 +16,7 @@ junit = "4.13.2"
 kotlin = "2.2.20"
 kotlinx-coroutines = "1.10.2"
 kotlinxSerializationJson = "1.8.1"
-ktor = "3.3.3"
+ktor = "3.4.0"
 logback = "1.5.18"
 
 [libraries]

codeSnippets/snippets/html/src/main/kotlin/com/example/Application.kt

@@ -25,5 +25,12 @@ fun Application.module() {
                 }
             }
         }
+        get("/fragment") {
+            call.respondHtmlFragment(HttpStatusCode.Created) {
+                div("fragment") {
+                    span { +"Created!" }
+                }
+            }
+        }
     }
 }

codeSnippets/snippets/htmx-integration/build.gradle.kts

@@ -4,7 +4,7 @@ val logback_version: String by project
 
 plugins {
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 group = "com.example"

codeSnippets/snippets/json-kotlinx-openapi/build.gradle.kts

@@ -1,5 +1,5 @@
 val ktor_version: String by project
-val kotlin_version: String by project
+val kotlin_version = "2.2.20"
 val logback_version: String by project
 val swagger_codegen_version: String by project
 
@@ -28,6 +28,7 @@ dependencies {
     implementation("io.ktor:ktor-server-content-negotiation:$ktor_version")
     implementation("io.ktor:ktor-serialization-kotlinx-json:$ktor_version")
     implementation("io.ktor:ktor-client-content-negotiation:$ktor_version")
+    implementation("io.ktor:ktor-server-routing-openapi:$ktor_version")
     implementation("io.swagger.codegen.v3:swagger-codegen-generators:$swagger_codegen_version")
     implementation("ch.qos.logback:logback-classic:$logback_version")
     testImplementation("io.ktor:ktor-server-test-host-jvm:$ktor_version")

codeSnippets/snippets/legacy-interactive-website/build.gradle.kts

@@ -4,7 +4,7 @@ val logback_version: String by project
 plugins {
     application
     kotlin("jvm")
-    id("io.ktor.plugin") version "3.3.3"
+    id("io.ktor.plugin") version "3.4.0"
 }
 
 application {

codeSnippets/snippets/migrating-express-ktor/gradle.properties

@@ -1,4 +1,4 @@
-ktor_version=3.3.3
+ktor_version=3.4.0
 kotlin_version=2.2.20
 logback_version=1.5.6
 kotlin.code.style=official

codeSnippets/snippets/openapi-spec-gen/README.md

@@ -0,0 +1,20 @@
+# OpenAPI documentation
+
+A sample Ktor project showing how to build OpenAPI documentation using routing annotations and the compiler 
+extension of the Ktor Gradle plugin.
+
+> This sample is a part of the [`codeSnippets`](../../README.md) Gradle project.
+
+## Run the application
+
+To run the application, execute the following command in the repository's root directory:
+
+```bash
+./gradlew :openapi-spec-gen:run
+```
+
+To view the OpenAPI documentation, navigate to the following URLs:
+
+- [http://0.0.0.0:8080/docs.json](http://0.0.0.0:8080/docs.json) to view a JSON document of the API spec.
+- [http://0.0.0.0:8080/openApi](http://0.0.0.0:8080/openApi) to view the OpenAPI UI for the API spec.
+- [http://0.0.0.0:8080/swaggerUI](http://0.0.0.0:8080/swaggerUI) to view the Swagger UI for the API spec.

codeSnippets/snippets/openapi-spec-gen/build.gradle.kts

@@ -0,0 +1,40 @@
+val ktor_version: String by project
+val kotlin_version = "2.2.20"
+val logback_version: String by project
+
+plugins {
+    application
+    kotlin("jvm")
+    id("io.ktor.plugin") version "3.4.0"
+}
+
+application {
+    mainClass = "io.ktor.server.netty.EngineMain"
+}
+
+repositories {
+    mavenCentral()
+    maven("https://maven.pkg.jetbrains.space/public/p/ktor/eap")
+}
+
+ktor {
+    openApi {
+        enabled = true
+        codeInferenceEnabled = true
+        onlyCommented = false
+    }
+}
+
+
+dependencies {
+    implementation("io.ktor:ktor-server-core:$ktor_version")
+    implementation("io.ktor:ktor-server-routing-openapi:$ktor_version")
+    implementation("io.ktor:ktor-server-openapi:$ktor_version")
+    implementation("io.ktor:ktor-server-content-negotiation:${ktor_version}")
+    implementation("io.ktor:ktor-serialization-kotlinx-json:${ktor_version}")
+    implementation("io.ktor:ktor-server-swagger:${ktor_version}")
+    implementation("io.ktor:ktor-server-netty:$ktor_version")
+    implementation("ch.qos.logback:logback-classic:$logback_version")
+    testImplementation("io.ktor:ktor-server-test-host-jvm:$ktor_version")
+    testImplementation("org.jetbrains.kotlin:kotlin-test")
+}