Ktor Routing, Documentation repository for Ktor. In Routing. Ktor routing dependencies Our target layer is routing and it is defined inside ModuleA and ModuleB. We'll create a simple Ktor rest api, and explore how to add and manage simple request routings. The configuration depends on the way you used to create a server - embeddedServer or EngineMain. routing. server. locations, have the same name as other methods defined in the io. It demonstrates a modular architecture with separate domain, application, and infrastructure layers, as well as dependency injection and routing organization. A path containing several path segments. Ktor is a framework for building asynchronous servers and clients in connected systems using the powerful Kotlin programming language. S. http. Enable easier testing and modular deployment. For information about the weather server sample that demonstrates dual client/server mode, see 7. Since Ktor doesn’t make use of a scanning mechanism, we need to provide the classes with those annotated functions. For EngineMain, Ktor loads its configuration from a configuration file that uses the HOCON or YAML format. If required, you can disable redirections. To accomplish this, you need to create a class that should act as a typed route and then annotate this class using the @Resource keyword. This tutorial covers setup, routing, and testing on a real-life example. It only depends on db/core, keeping the domain separate from infrastructure details. It’s an ideal entry-level tutorial for Kotlin backend developers. This way provides more flexibility . This statement using the custom function processRoutes processes the functions that have those custom annotations and makes it transparent for Ktor. On the left, we have our application and, on the right, each module dependencies. We can then create routes using verbs and paths or we can group routes by URL and of course we can also have sub-routes In this tutorial, we explored the basics of setting up HTTP routing in Kotlin using Ktor. content. The Ktor is built from the ground up using Kotlin and Coroutines. kt, we import io. html - (some files Redirect  Edit page Last modified: 02 April 2024 By default, the Ktor client redirects to URLs provided in the Location header. Get started with building your first Ktor Server application. Ktor also offers a comprehensive set of features, including support for asynchronous programming, routing, templating, and HTTP clients and servers. Instead, you have access to different stages of handling requests and responses using the onCall, onCallReceive, and onCallRespond handlers. 基本的なことはドキュメントに書いてあるのでそれに倣う。 今回はExposedを使ったプロジェクトに型安全なRoutingを当て込んでみる。 環境 このリポジトリに定義している。型安全でないブランチがanswearで型安全にしたブランチがtype-safe-routi This article is the first part of the three-part series that will smoothly introduce Ktor as a backend to you. If you import the routing package before the locations one, the IDE might suggest you generalize those methods instead of importing the right package. 0. In Kotlin, we Hey there, fellow Android devs! Ready to spice up your app’s networking game? Say hello to Ktor — your new best friend for smooth, coroutine-powered networking in Kotlin. Feb 2, 2026 · Learn how to set up a Ktor server with routing, including route organization, parameter handling, authentication, and best practices for building scalable APIs. It facilitates developing a standalone application with embedded servers. 0, Ktor provides a new API for creating custom plugins. This plugin allows you to configure allowed hosts, HTTP methods, headers set by the client, and so on. Routing is the core Ktor plugin (formerly known as feature) for handling incoming requests in a server application. module() function configures the application’s routing and other features. Kotlin Routing A multiplatform, extensible, and independent routing library powered by Ktor. By the end of this tutorial you will know how to do the following: Handle GET and POST requests. Instead, you can organize routes in a way that best fits the size and complexity of your application, and many projects combine the patterns described below. Ktor, an asynchronous Ktor 是一个使用强大的 Kotlin 语言 在互联系统中构建异步服务器与客户端的框架。 本站提供了 Ktor 应用程序结构与编程接口的完整参考，以及如何处理特定任务的参考。 这里是查找你要寻找的答案并了解其工作原理的地方。 从搜索信息或者浏览下文的几节开始。 As per Ktor documentation, we can access the path parameters in routes using call. Routing is a fundamental part of any web server, and Ktor makes it intuitive and flexible. P. You get to use a concise, multiplatform language, as well as the power of asynchronous programming with an intuitive imperative flow. io. Ktor是基于Kotlin的高性能Web框架，支持异步服务器和跨平台客户端开发。本文详细介绍Ktor服务端配置、路由、CORS处理及打包部署，并以RxCache浏览器为例展示Ktor实际应用。Ktor简洁高效，适合Web项目、API接口和微服务开发。 The koin-ktor module provides dependency injection integration for Ktor applications, working alongside Ktor's built-in DI system. Ktor makes an automatic redirect to the authorization page for a specific provider and passes the necessary parameters: A client ID used to access APIs of the selected provider. A module is an extension function on Application that sets up routes, installs plugins, and configures services. Gets a request HTTP method possibly overridden using the X-Http-Method-Override header. Using Kotlin Coroutines with KTOR Routing When building web applications, one of the key concerns is how to manage asynchronous operations. P. In Ktor, routing is how we direct a request to the correct endpoint that our app will eventually call. paramters ["params"] as given below, get ("/user/ {login}") { if (call. If selector matches current routing evaluation context, the algorithm goes down to the Routing is the core Ktor plugin for handling incoming requests in a server application. Contribute to ktorio/ktor-samples development by creating an account on GitHub. I am a noobie in Ktor and Kotlin. Routes define paths that your server responds to, allowing you to structure your application into Learn to build Kotlin RESTful APIs with Ktor. parameters Edit page Last modified: 30 October 2025 Ktor allows you to configure various server parameters, such as a host address and port, modules to load, and so on. routing package. Today, we'll explore Ktor, a toolkit for building server applicati 简单路由 首先，我们要使用 路由特性。 这个特性是 Ktor 核心的一部分，因此不需要 包含任何其他构件。 这一特性在使用 routing { } DSL 块时自动安装。 Let’s start creating a simple GET route that responds with OK by using the get method available inside the routing block: I am trying to migrate some code which uses the @Location annotation from the Locations plugin (a deprecated plugin in ktor since release 1. Routing: Organize API Endpoints Efficiently Defining API routes and organizing different request handlers was made possible with the Routing plugin which is the core part of Ktor. Microservices: Its lightweight and modular design makes it suitable for microservice architectures. Additionally, these requests can contain different types of parts, such as form fields, files, or binary data, which need to be handled differently. Jan 23, 2026 · One of Ktor's strong points is its flexibility and that it does not enforce a single routing organization strategy. respondRedirect("relative/url") sends a HTTP 302 or 301 depending on the permantent: B OAuth authorization flow  The OAuth authorization flow in a Ktor application might look as follows: A user opens a login page in a Ktor application. get , java. Using modules helps you: Group related routes and logic together. Multipart request data is processed sequentially, so you can't directly access a specific part of it. Before we talk about how we can group routes, let’s first discuss ways in which we can define them. ktor. With MultiPartFormDataContent, you can also monitor upload progress using the onUpload callback. Something which is again quite flexible in Ktor. For a full example of a modular, layered Ktor server application, see the Ktor Chat sample project. Contribute to jmcshane/ktor-wiki development by creating an account on GitHub. This article offers a comprehensive troubleshooting guide for resolving such challenges in Ktor-powered applications at scale. Routing Routing in Ktor defines how HTTP requests are handled. I have the following hierarchy in my static folder (working directory): - static - index. 6) to @Resource from the Resources plugin. The Node contains handlers and interceptors, and the selector is attached to an arc which connects another node. Generally routes are defined using the routingfunction. The Tree is built with nodes and selectors. * , io. We covered how to define endpoints, handle various HTTP methods, and organize routes effectively. When the client makes a request to a specific URL (for example, /hello ), the routing mechanism allows us to define how we want this request to be served. To stream large or dynamic content efficiently, you can use MultiPartFormDataContent with an InputProvider. 2. In general, this API doesn't require an understanding of internal Ktor concepts, such as pipelines, phases, and so on. Ktor allows you to use modules to structure your application by defining a specific set of routes inside a specific module. File and use the staticFiles function to define the route that serves the file, the folder and the file that is served as default. Jan 23, 2026 · Routing is the core Ktor plugin for handling incoming requests in a server application. If your server is supposed to handle cross-origin requests, you need to install and configure the CORS Ktor plugin. receiveMultipart() function and then loop over each part as required. 5. ESPN has evolved far beyond its origins as a simple sports network to become the definitive entertainment destination for sports enthusiasts worldwide. You'll learn to start writing server code with Kotlin using the Ktor framework. Routing organization  Edit page Last modified: 23 January 2026 One of Ktor's strong points is its flexibility and that it does not enforce a single routing organization strategy. New Ktor Project Download a project skeleton using the provided options and plugins below. If you would like to contribute your own plugins, you can publish to the registry repository. Ktor is a lightweight Kotlin framework designed specifically for building asynchronous server-side applications. In 2025, the ESPN ecosystem encompasses everything from live MLB Baseball and NFL Football games to cutting-edge digital experiences that redefine how we consume sports entertainment. In this tutorial, you’ll learn the basics of routing, handling requests, and parameters in Kotlin with Ktor by building a task manager application. Each route maps a URL path to a handler. The setup as described here works, but I am running into trouble when I try to refactor some code that uses route. ルーティングツリー KtorのRoutingプラグインは、 Route オブジェクトをノードとするツリーを構築し、それを用いてHTTPリクエストとマッチングを行うことで、各リクエストに対してどういう処理が呼び出されるべきかを決定します。 routing { // I want to provide the root endpoint (/api/v1) here postRoutes() } } How can I setup my root endpoint (/api/v1) in this case? P. When the client makes a request to a specific URL (for example, /hello), the routing mechanism allows us to define how we want this request to be served. more Building REST APIs: Ktor’s routing DSL and support for content negotiation make it a great tool for building REST APIs. The custom code wraps these functions in the regular Route definition of Ktor. [Day 11] Ktor 的 Routing 進階技法 隨著專案功能的增加，我們對外開放的 route 也會越來越多。 今天我們來談談怎麼調整我們的 route route group 首先，我們可以將相關的 route 放在同一個 function 裡面，比方說： 把 get("/foo/bar") { … } // (1) get("/foo/baz") { … } // (2) get("/foo/baz/qux") { … } // (3) 改成 route("/foo") { get Introduction As an experienced Java developer, you're likely familiar with robust, full-featured web frameworks, like Spring Boot. Does the Ktor framework provide a way of accessing a route's path string within a request? For example, if I set up a route such as: routing { get ("/user/ {user_id}") { // poss Framework for quickly creating connected applications in Kotlin with minimal effort - ktorio/ktor Create a RESTful API Learn how to build a RESTful API with Ktor. In this tutorial you will learn how to create, open and run a new Ktor project. Keep features or domains isolated. Routing Tree Routing is organized in a tree with a recursive matching system that is capable of handling quite complex rules for request processing. The sample showcases two approaches to server configuration: manual SSE setup with explicit session management, and the recommended Ktor plugin approach. Use unit tests to validate My question is about the big picture behind routing functionality in Ktor; and scalability when it comes to design an API with large number of routes. Sample projects for Ktor. If I create an app like this: import io. It is ideal for developing APIs due to its simplicity, flexibility, and coroutine Ktor provides the Resources plugin that allows you to implement type-safe routing. Create routing independently and extend it to what you need. In this video, we dive deep into Routing in Ktor, covering everything from basic routes to advanced techniques like type-safe and nested routing. We figured out how to work with Routing in Ktor, simple and nested paths, passing parameters, and using wildcards to create flexible endpoints that a user can use to access our application. InputProvider allows you to supply file data as a buffered stream rather than loading it entirely into memory, making it well-suited for large files. The Application. Whether you're wondering how to watch live sports online or Edit page Last modified: 06 February 2025 A typical request/response pipeline in Ktor looks like the following: It starts with a request, which is routed to a specific handler, processed by our application logic, and finally responded to. location(someRandomLocation) { }, where someRandomLocation represented a resource (possibly nested I'm wondering if there's a way to do an internal redirect, re-route, or response forwarding inside Ktor. Extract information from requests. Furthermore, Ktor’s compatibility with different environments and systems, such as Android and cloud platforms, has made it a go-to choice for many Kotlin developers. It’s very similar to how we handle Navigation Components to move between different screens I would love to understand better how Ktor is handling the routing for static content. To receive a file sent as a part of a multipart request, call the . KtorでのRoutingの定義方法 まず、前提としてRouting定義の基礎知識です。 Ktorでは、Routingを定義する方法が大きく2つあります。 標準の Routing のみを使う方法と、それにexperimentalな機能である Location を組み合わせる方法です。 Routing単体で定義する場合 Starting with v2. Handle errors when converting data. call. I've checked their docs, it says to use nested route s but I can't because I need to call routing in postRoutes() that breaks nested routes. However, enterprise teams using Ktor often encounter issues such as routing conflicts, coroutine leaks, deployment misconfigurations, JSON serialization errors, and middleware pipeline bugs. Routing Resolve Context class RoutingResolveContext ( val routing: RoutingNode, val call: PipelineCall, tracers: List <(RoutingResolveTrace) -> Unit>) Represents a context in which routing resolution is being performed Routing Resolve Result sealed class RoutingResolveResult Some of these generic methods with one type parameter, defined in the io. kz5iw, hn9v2, 3afu, pklz8, 8dpcc, 1fdcf, cyihc, xsimqs, 4frz, zsu1e6,