ktor README

The project's README from github.com/ktorio/ktor. As one markdown file: README.md.

Ktor logo

Official JetBrains project Maven Central Kotlin Slack channel GitHub License Contribute with Gitpod

Ktor is an asynchronous framework for creating microservices, web applications and more. Written in Kotlin from the ground up.

First add the dependency to your project:

repositories {
    mavenCentral()
}

dependencies {
    implementation("io.ktor:ktor-server-netty:$ktor_version")
}

Then create an Application and install some features:

import io.ktor.server.netty.*
import io.ktor.server.routing.*
import io.ktor.server.application.*
import io.ktor.http.*
import io.ktor.server.response.*
import io.ktor.server.engine.*

fun main(args: Array<String>) {
    embeddedServer(Netty, 8080) {
        routing {
            get("/") {
                call.respondText("Hello, world!", ContentType.Text.Html)
            }
        }
    }.start(wait = true)
}

You also can use Ktor Gradle Plugin to configure bom, run tasks and deployment:

plugins {
    id("io.ktor.plugin") version "3.1.1"
}

dependencies {
    implementation("io.ktor:ktor-server-netty")
}

To run the created application, execute:

./gradlew run

Start using Ktor

Build your first Kotlin HTTP or RESTful application using Ktor: start.ktor.io

Principles

Unopinionated

Ktor Framework doesn't impose a lot of constraints on what technology a project is going to use – logging, templating, messaging, persistence, serialization, dependency injection, etc. Sometimes it may be required to implement a simple interface, but usually it is a matter of writing a transforming or intercepting function. Features are installed into the application using a unified interception mechanism which allows building arbitrary pipelines.

Ktor Applications can be hosted in any servlet container with Servlet 3.0+ API support such as Tomcat, or standalone using Netty or Jetty. Support for other hosts can be added through the unified hosting API.

Ktor APIs are mostly functions calls with lambdas. Thanks to Kotlin DSL capabilities, the code looks declarative. Application composition is entirely up to the developer's choice – with functions or classes, using dependency injection framework or doing it all manually in the main function.

Asynchronous

The Ktor pipeline machinery and API are utilising Kotlin coroutines to provide easy-to-use asynchronous programming model without making it too cumbersome. All host implementations are using asynchronous I/O facilities to avoid thread blocking.

Testable

Ktor applications can be hosted in a special test environment, which emulates a web server to some extent without actually doing any networking. It provides easy way to test an application without mocking too much stuff, and still achieve good performance while validating application calls. Running integration tests with a real embedded web server are of course possible, too.

JetBrains Product

Ktor is an official JetBrains product and is primarily developed by the team at JetBrains, with contributions from the community.

Documentation

Please visit ktor.io for Quick Start and detailed explanations of features, usage and machinery.

Reporting Issues / Support

Please use our issue tracker for filing feature requests and bugs. If you'd like to ask a question, we recommend StackOverflow where members of the team monitor frequently.

There is also community support on the Kotlin Slack Ktor channel

Reporting Security Vulnerabilities

If you find a security vulnerability in Ktor, we kindly request that you reach out to the JetBrains security team via our responsible disclosure process.

Inspirations

Kotlin web frameworks such as Wasabi and Kara, which are currently deprecated.

Contributing

Please see the contribution guide and the Code of conduct before contributing.

ktor (ktorio/ktor)

Searching Database…

14.5K ·GitHub
Ktor
Что это такое?Ktor — это асинхронный фреймворк для создания микросервисов, веб-приложений и многого другого, написанный на Kotlin с нуля.
Это фреймворк или библиотека?Полноценный фреймворк: вы создаёте Application и устанавливаете в него фичи, которые подключаются через единый механизм перехвата, позволяющий собирать произвольные конвейеры обработки.
Как запустить первое приложение?Добавьте зависимость, создайте Application и установите фичи вроде routing, затем запустите — встроенный веб-сервер поднимется на localhost:8080. На start.ktor.io можно сгенерировать стартовый проект.
Что нужно на компьютере, чтобы этим пользоваться?Проект на Kotlin, собираемый через Gradle или Maven; для обоих вариантов есть руководства по началу работы, плюс гайды для IntelliJ IDEA. Опциональный Ktor Gradle Plugin настраивает BOM, задачи запуска и деплой.
Ktor навязывает конкретные решения для логирования, сериализации или шаблонов?Нет — он намеренно не навязывает никаких выборов. Он не ограничивает вас в логировании, шаблонах, обмене сообщениями, хранении данных, сериализации или внедрении зависимостей; как правило, достаточно функции-обёртки или перехватчика.
Как выглядит код на Ktor?В основном это вызовы функций с лямбдами — возможности Kotlin DSL делают код декларативным на вид. Как собирать приложение, решаете вы: функции или классы, DI-фреймворк, или всё в main().
Как тестировать приложение на Ktor?Запустите его в специальной тестовой среде, которая эмулирует веб-сервер без реальной сети, — так вы проверяете вызовы почти без моков и с хорошей производительностью. Интеграционные тесты против настоящего встроенного сервера тоже работают.
Это официальный проект JetBrains?Да — Ktor — официальный продукт JetBrains, который в основном развивает команда JetBrains при участии сообщества. Вдохновение он черпал из закрытых веб-фреймворков для Kotlin — Wasabi и Kara.
What are similar projects?Rocket, express, koa, aiohttp, tornado, axum, starlette, fiber
Which topics is it in?kotlin-coroutines, netty, coroutines, dsl, asynchronous, gradle, jetbrains, web-server, middleware, jvm, async, web-framework
Creator
ktorio
Size
149.9 MB
Stars
14.5K
Updated
CommitOct 12Release3.6.0Sep 18
Age
11y
Commits · 90 Days