Refine Ktor-style routing DSL examples and tests

MukjepScarlet · MukjepScarlet · commit f3bd768812c8 · 2026-05-13T17:42:10.000+08:00
diff --git a/examples/echo-server/src/main/kotlin/EchoServerExample.kt b/examples/echo-server/src/main/kotlin/EchoServerExample.kt
@@ -1,19 +1,24 @@
 import com.google.gson.JsonObject
-import io.netty.handler.codec.http.FullHttpResponse
 import net.ccbluex.netty.http.HttpServer
-import net.ccbluex.netty.http.model.RequestObject
-import net.ccbluex.netty.http.util.httpOk
+import net.ccbluex.netty.http.routing.Routing
+import net.ccbluex.netty.http.routing.RoutingContext
 
 suspend fun main() {
     val server = HttpServer()
 
     server.routing {
-        post("/echo", ::postEcho) // /echo
+        echoRoutes()
     }
 
     server.start(8080)  // Start the server on port 8080
 }
 
-fun postEcho(requestObject: RequestObject): FullHttpResponse {
-    return httpOk(requestObject.asJson<JsonObject>())
-}
+fun Routing.echoRoutes() {
+    route("/echo") {
+        post { postEcho() }
+    }
+}
+
+private suspend fun RoutingContext.postEcho() {
+    respond(receive<JsonObject>())
+}
diff --git a/examples/file-server/src/main/kotlin/FileServerExample.kt b/examples/file-server/src/main/kotlin/FileServerExample.kt
@@ -1,9 +1,7 @@
 import com.google.gson.JsonObject
-import io.netty.handler.codec.http.FullHttpResponse
 import net.ccbluex.netty.http.HttpServer
-import net.ccbluex.netty.http.model.RequestObject
-import net.ccbluex.netty.http.util.httpBadRequest
-import net.ccbluex.netty.http.util.httpOk
+import net.ccbluex.netty.http.routing.Routing
+import net.ccbluex.netty.http.routing.RoutingContext
 import java.io.File
 
 const val FOLDER_NAME = "files"
@@ -15,11 +13,7 @@ suspend fun main() {
     println("Serving files from: ${folder.absolutePath}")
 
     server.routing {
-        get("/", ::getRoot)
-        get("/conflicting", ::getConflictingPath)
-        get("/a/b/c", ::getConflictingPath)
-        get("/file/:name", ::getFileInformation)
-        post("/file/:name", ::postFile)
+        fileRoutes()
 
         // register file serving at the bottom of the routing tree
         // to avoid overwriting other routes
@@ -29,50 +23,60 @@ suspend fun main() {
     server.start(8080)  // Start the server on port 8080
 }
 
-@Suppress("UNUSED_PARAMETER")
-fun getRoot(requestObject: RequestObject): FullHttpResponse {
-    // Count the number of files in the folder
-    // Walk the folder and count the number of files
-    return httpOk(JsonObject().apply {
+fun Routing.fileRoutes() {
+    get("/") { getRoot() }
+    get("/conflicting") { getConflictingPath() }
+
+    route("/a") {
+        route("/b") {
+            get("/c") { getConflictingPath() }
+        }
+    }
+
+    route("/file") {
+        get("/:name") { getFileInformation() }
+        post("/:name") { postFile() }
+    }
+}
+
+private suspend fun RoutingContext.getRoot() {
+    respond(JsonObject().apply {
         addProperty("path", folder.absolutePath)
         addProperty("files", folder.walk().count())
     })
 }
 
-@Suppress("UNUSED_PARAMETER")
-fun getConflictingPath(requestObject: RequestObject): FullHttpResponse {
-    return httpOk(JsonObject().apply {
+private suspend fun RoutingContext.getConflictingPath() {
+    respond(JsonObject().apply {
         addProperty("message", "This is a conflicting path")
     })
 }
 
-@Suppress("UNUSED_PARAMETER")
-fun getFileInformation(requestObject: RequestObject): FullHttpResponse {
-    val name = requestObject.params["name"] ?: return httpBadRequest("Missing name parameter")
+private suspend fun RoutingContext.getFileInformation() {
+    val name = parameters["name"] ?: badRequest("Missing name parameter")
     val file = File(folder, name)
 
     if (!file.exists()) {
-        return httpBadRequest("File not found")
+        badRequest("File not found")
     }
 
-    return httpOk(JsonObject().apply {
+    respond(JsonObject().apply {
         addProperty("name", file.name)
         addProperty("size", file.length())
         addProperty("lastModified", file.lastModified())
     })
 }
 
-@Suppress("UNUSED_PARAMETER")
-fun postFile(requestObject: RequestObject): FullHttpResponse {
-    val name = requestObject.params["name"] ?: return httpBadRequest("Missing name parameter")
+private suspend fun RoutingContext.postFile() {
+    val name = parameters["name"] ?: badRequest("Missing name parameter")
     val file = File(folder, name)
 
     if (file.exists()) {
-        return httpBadRequest("File already exists")
+        badRequest("File already exists")
     }
 
-    file.writeText(requestObject.body)
-    return httpOk(JsonObject().apply {
+    file.writeText(body)
+    respond(JsonObject().apply {
         addProperty("message", "File written")
     })
-}
+}
diff --git a/examples/hello-world/src/main/kotlin/HelloWorldExample.kt b/examples/hello-world/src/main/kotlin/HelloWorldExample.kt
@@ -1,41 +1,45 @@
 import com.google.gson.JsonObject
-import io.netty.handler.codec.http.FullHttpResponse
 import net.ccbluex.netty.http.HttpServer
-import net.ccbluex.netty.http.model.RequestObject
-import net.ccbluex.netty.http.util.httpOk
+import net.ccbluex.netty.http.routing.Routing
+import net.ccbluex.netty.http.routing.RoutingContext
 
 suspend fun main() {
     val server = HttpServer()
 
     server.routing {
-        get("/", ::getRoot)
-        get("/hello", ::getHello) // /hello?name=World
-        get("/hello/:name", ::getHello) // /hello/World
-        get("/hello/:name/:age", ::getHelloWithAge) // /hello/World/20
+        helloWorldRoutes()
     }
 
     server.start(8080)  // Start the server on port 8080
 }
 
-@Suppress("UNUSED_PARAMETER")
-fun getRoot(requestObject: RequestObject): FullHttpResponse {
-    return httpOk(JsonObject().apply {
+fun Routing.helloWorldRoutes() {
+    get("/") { getRoot() }
+
+    route("/hello") {
+        get { getHello() } // /hello?name=World
+        get("/:name") { getHello() } // /hello/World
+        get("/:name/:age") { getHelloWithAge() } // /hello/World/20
+    }
+}
+
+private suspend fun RoutingContext.getRoot() {
+    respond(JsonObject().apply {
         addProperty("root", true)
     })
 }
 
-fun getHello(requestObject: RequestObject): FullHttpResponse {
-    val name = requestObject.params["name"] ?: requestObject.queryParams["name"] ?: "World"
-    return httpOk(JsonObject().apply {
+private suspend fun RoutingContext.getHello() {
+    val name = parameters["name"] ?: queryParameters["name"] ?: "World"
+    respond(JsonObject().apply {
         addProperty("message", "Hello, $name!")
     })
 }
 
-fun getHelloWithAge(requestObject: RequestObject): FullHttpResponse {
-    val name = requestObject.params["name"] ?: "World"
-    val age = requestObject.params["age"] ?: "0"
-    return httpOk(JsonObject().apply {
+private suspend fun RoutingContext.getHelloWithAge() {
+    val name = parameters["name"] ?: "World"
+    val age = parameters["age"] ?: "0"
+    respond(JsonObject().apply {
         addProperty("message", "Hello, $name! You are $age years old.")
     })
 }
-
diff --git a/examples/zip-server/build.gradle.kts b/examples/zip-server/build.gradle.kts
@@ -23,7 +23,7 @@ dependencies {
 }
 
 application {
-    mainClass.set("HelloWorldExampleKt")
+    mainClass.set("ZipServerExampleKt")
 }
 
 tasks.test {
@@ -36,11 +36,11 @@ tasks.withType<JavaCompile> {
 
 tasks.withType<Jar> {
     manifest {
-        attributes["Main-Class"] = "HelloWorldExampleKt"
+        attributes["Main-Class"] = "ZipServerExampleKt"
     }
 
     // Include runtime dependencies in the JAR
     from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) })
     // Prevent duplicate files from being added to the JAR
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE
-}
+}
diff --git a/examples/zip-server/src/main/kotlin/ZipServerExample.kt b/examples/zip-server/src/main/kotlin/ZipServerExample.kt
@@ -19,15 +19,19 @@
  */
 
 import net.ccbluex.netty.http.HttpServer
-import net.ccbluex.netty.http.rest.RouteController
+import net.ccbluex.netty.http.routing.Routing
 import java.io.File
 
 suspend fun main() {
     // Start server
     val server = HttpServer()
     server.routing {
-        zip("/static", File("example.zip").inputStream())
+        zipRoutes()
     }
 
     server.start(8080)
 }
+
+fun Routing.zipRoutes() {
+    zip("/static", File("example.zip").inputStream())
+}
diff --git a/src/main/kotlin/net/ccbluex/netty/http/routing/Routing.kt b/src/main/kotlin/net/ccbluex/netty/http/routing/Routing.kt
@@ -0,0 +1,5 @@
+package net.ccbluex.netty.http.routing
+
+import net.ccbluex.netty.http.rest.Node
+
+typealias Routing = Node
diff --git a/src/test/kotlin/HttpMiddlewareServerTest.kt b/src/test/kotlin/HttpMiddlewareServerTest.kt
@@ -1,12 +1,11 @@
 import com.google.gson.JsonObject
-import io.netty.handler.codec.http.FullHttpResponse
 import io.netty.handler.codec.http.HttpResponseStatus
 import kotlinx.coroutines.runBlocking
 import net.ccbluex.netty.http.HttpServer
 import net.ccbluex.netty.http.middleware.Middleware
-import net.ccbluex.netty.http.model.RequestObject
+import net.ccbluex.netty.http.routing.Routing
+import net.ccbluex.netty.http.routing.RoutingContext
 import net.ccbluex.netty.http.util.httpBadRequest
-import net.ccbluex.netty.http.util.httpOk
 import okhttp3.OkHttpClient
 import okhttp3.Request
 import okhttp3.Response
@@ -63,7 +62,7 @@ class HttpMiddlewareServerTest {
         val server = HttpServer()
 
         server.routing {
-            get("/", ::static)
+            middlewareRoutes()
         }
 
         server.middleware(Middleware.OnResponse { requestContext, fullHttpResponse ->
@@ -85,13 +84,16 @@ class HttpMiddlewareServerTest {
         server
     }
 
-    @Suppress("UNUSED_PARAMETER")
-    fun static(requestObject: RequestObject): FullHttpResponse {
-        return httpOk(JsonObject().apply {
+    private suspend fun RoutingContext.static() {
+        respond(JsonObject().apply {
             addProperty("message", "Hello, World!")
         })
     }
 
+    private fun Routing.middlewareRoutes() {
+        get("/") { static() }
+    }
+
     /**
      * Utility function to make HTTP GET requests to the specified path.
      *
diff --git a/src/test/kotlin/HttpServerTest.kt b/src/test/kotlin/HttpServerTest.kt

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ dependencies {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`application {`
`26`		`- mainClass.set("HelloWorldExampleKt")`
	`26`	`+ mainClass.set("ZipServerExampleKt")`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`tasks.test {`
`@@ -36,11 +36,11 @@ tasks.withType<JavaCompile> {`
`36`	`36`
`37`	`37`	`tasks.withType<Jar> {`
`38`	`38`	`manifest {`
`39`		`- attributes["Main-Class"] = "HelloWorldExampleKt"`
	`39`	`+ attributes["Main-Class"] = "ZipServerExampleKt"`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`// Include runtime dependencies in the JAR`
`43`	`43`	`from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) })`
`44`	`44`	`// Prevent duplicate files from being added to the JAR`
`45`	`45`	`duplicatesStrategy = DuplicatesStrategy.EXCLUDE`
`46`		`-}`
	`46`	`+}`