IntelliJ IDEA provides the following capabilities for working with Ktor projects:
A wizard for creating new projects.
A dedicated run configuration for running and debugging Ktor projects.
Navigating between routes across a project.
Generating tests for routes and adding sample code for Ktor plugins.
Code editing assistance, including completion and renaming route names.
Migrating projects to the latest Ktor version.
Create a new Ktor project
On the Welcome screen, click New Project.
Otherwise, from the main menu, select.
In the New Project wizard, choose Ktor from the list on the left.
On the right pane, you can specify the following settings:
Name: Specify a project name.
Location: Specify a directory for your project.
Build System: Choose the desired build system. This can be Gradle with Kotlin or Groovy DSL, or Maven.
Website: Specify a domain used to generate a package name.
Artifact: This field shows a generated artifact name.
Ktor version: Choose the required Ktor version.
Engine: Select an engine used to run a server.
Configuration in: Choose whether to specify server parameters in code or in a HOCON file.
Add sample code: Use this option to add sample code for plugins, which will be added on the next page.
On the next page, you can choose a set of plugins - building blocks that provide common functionality of a Ktor application, such as authentication, serialization and content encoding, compression, cookie support, and so on.
Click Create and wait until IntelliJ IDEA generates a project and installs the dependencies.
Run a Ktor application
IntelliJ IDEA creates a Ktor run/debug configuration automatically for newly created or imported Ktor projects. If necessary, you can manage creating run configurations by using the Create Run Configuration automatically option on the page.
To run an application using the Ktor run configuration, follow these steps:
Select the Ktor run configuration in the main toolbar and click or press Shift+F10.
Wait until IntelliJ IDEA runs the application. The Run tool window should show the following message:[main] INFO ktor.application - Responding at http://0.0.0.0:8080
This means that the server is ready to accept requests at the http://0.0.0.0:8080 address.
Find routes with Search Everywhere
To find a specific route in your application using Search everywhere, follow the steps below:
Press Shift twice to open the search window.
Start typing a route name.
To narrow down your search, click the Filter icon on the window toolbar and select URLs.
Navigate between a route and its usages
To navigate between a route and its usages in a project, do one of the following:
Place the caret at the desired path or URL and press Ctrl+B.
Keeping Ctrl pressed, hover the mouse pointer over the path or URL. When a URL turns into a hyperlink, click it without releasing the key.
Click the icon next to the path or URL and choose Go to declaration or usages from a popup.
IntelliJ IDEA will show related paths/URLs:
Show routes in the Endpoints tool window
To see all the routes defined in your Ktor application, you can use the Endpoints tool window:
Click the icon next to the path and choose Show all endpoints of module from a popup.
In the invoked Endpoints tool window, you can see all the routes defined in your application.
IntelliJ IDEA allows you to generate tests for modules, groups of routes, or individual routes. This functionality is supported for both HTTP and WebSocket endpoints. To generate tests, follow the steps below:
Place the caret at the desired module or route, press Alt+Enter, and choose one of the following actions:
Create test for Ktor module
Create test for Ktor routes
Create test for Ktor route
In the invoked dialog, you can specify a test class name, choose the desired routes, and edit individual test names.
IntelliJ IDEA will create a test class containing tests requests for the selected routes.
You can learn how to test a Ktor server from Testing.
Generate code for plugins
IntelliJ IDEA allows you to generate code for Ktor plugins using the code completion popup.
Place the caret inside a module, start typing
installand then choose the desired plugin from the list.
Press Enter. IntelliJ IDEA generates code for the selected plugin and adds the required dependencies to the build script.
Complete route names
IntelliJ IDEA allows you to complete the names of routes:
Place the caret at the parameter that accepts a URL and press Ctrl+Space. The editor will show you the available routes.
In IntelliJ IDEA, you can use rename refactoring to rename routes:
Place the caret at the route name and press Shift+F6.
Specify a new route name and click Refactor.
Test endpoints in the HTTP editor
IntelliJ IDEA allows you to test HTTP endpoints using the HTTP client in code editor:
Place the caret at the desired path, press Alt+Enter, and choose Generate request in HTTP Client.
In the opened file, adjust request parameters.
Click in the gutter to make a request.
Migrate a project
In IntelliJ IDEA, you can migrate your Ktor project to the latest version in one of the following ways:
When opening a project that uses a previous Ktor version, IntelliJ IDEA suggests you migrate this project or a specific module to the latest version.
You can migrate a project/module or click Actions to configure a migration level or cancel migration and disable this popup.
Press Ctrl+Shift+A, find the Migrate Ktor to Latest Version action, and press Enter.
Configure a migration level
To configure a migration level or disable migrations at all, use a corresponding option on thepage.