Building Kotlin Backends with Ktor: A Practical Tutorial

Ktor is a lightweight, asynchronous framework for building HTTP backends in Kotlin. It’s highly modular and perfect for everything from microservices to full REST APIs. In this tutorial, you’ll create a simple server with JSON endpoints using Ktor and kotlinx.serialization.

Before you begin, ensure you have IntelliJ IDEA (or any Kotlin‑compatible IDE) and JDK 11+. We’ll use Gradle with Kotlin DSL as the build system.

Article illustration

1. Create a Ktor Project

Add the following dependencies in your build.gradle.kts:

  • io.ktor:ktor-server-core – core server module
  • io.ktor:ktor-server-netty – Netty engine
  • io.ktor:ktor-server-content-negotiation – for JSON support
  • io.ktor:ktor-serialization-kotlinx-json – serialization plugin

Optionally add the Ktor plugin to your Gradle build for easy version management.

2. Define the Main Server Entry Point

Create Application.kt and write:

fun main() {
    embeddedServer(Netty, port = 8080) {
        configureRouting()
    }.start(wait = true)
}

Now define configureRouting() in a separate file or extension function.

3. Add Routes and JSON Serialization

Install the ContentNegotiation plugin and configure JSON:

fun Application.configureRouting() {
    install(ContentNegotiation) {
        json(Json { ignoreUnknownKeys = true })
    }
    routing {
        get("/hello") {
            call.respondText("Hello, Ktor!")
        }
        post("/user") {
            val user = call.receive<User>()
            call.respond(mapOf("created" to true, "name" to user.name))
        }
    }
}

Define a data class User with @Serializable annotation from kotlinx.serialization.

4. Run and Test Your API

Execute the main() function. Your server starts on http://localhost:8080. Use a tool like curl or Postman to test:

  • GET /hello – returns a plain text response.
  • POST /user with a JSON body {"name":"Alice"} – returns a JSON object.

Conclusion

You now have a working Ktor backend with JSON support. Explore routing, authentication, and plugins to build more complex APIs. Ktor’s DSL keeps your code clean and Kotlin‑idiomatic.

sarah antaboga
Author: sarah antaboga

Leave a Reply

Your email address will not be published. Required fields are marked *