Creates a route to match a request's host and port. There are no any host resolutions/transformations applied to a host: a request host is treated as a string.

fun Route.host(hosts: List<String>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route

fun Route.host(hostPattern: Regex, port: Int = 0, build: Route.() -> Unit): Route

Creates a route to match a request host and port. There are no any host resolutions/transformations applied to a host: a request host is treated as a string.

fun Route.host(hosts: List<String>, hostPatterns: List<Regex>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route

Creates a route to match s request host and port. There are no any host resolutions/transformations applied to a host: a request host is treated as a string.

localPort

fun Route.localPort(port: Int, build: Route.() -> Unit): Route

Creates a route to match a port on which a call was received.

method

fun Route.method(method: <ERROR CLASS>, body: Route.() -> Unit): Route

Builds a route to match the specified HTTP method.

optionalParam

fun Route.optionalParam(name: String, build: Route.() -> Unit): Route

Builds a route to capture an optional parameter with specified name, if it exists.

options

fun Route.options(body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match OPTIONS requests.

fun Route.options(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match OPTIONS requests with the specified path.

param

fun Route.param(name: String, build: Route.() -> Unit): Route

Builds a route to match a parameter with the specified name and captures its value.

fun Route.param(name: String, value: String, build: Route.() -> Unit): Route

Builds a route to match a parameter with the specified name and value.

patch

fun Route.patch(body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match PATCH requests.

@JvmName(name = "patchTyped")

inline fun <R : Any> Route.patch(crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match PATCH requests receiving a request body as content of the R type.

fun Route.patch(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match PATCH requests with the specified path.

@JvmName(name = "patchTypedPath")

inline fun <R : Any> Route.patch(path: String, crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match PATCH requests with the specified path receiving a request body as content of the R type.

port

fun Route.port(vararg ports: Int, build: Route.() -> Unit): Route

Creates a route to match a request port.

post

fun Route.post(body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match POST requests.

@JvmName(name = "postTyped")

inline fun <R : Any> Route.post(crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match POST requests receiving a request body as content of the R type.

fun Route.post(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match POST requests with the specified path.

@JvmName(name = "postTypedPath")

inline fun <R : Any> Route.post(path: String, crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match POST requests with the specified path receiving a request body as content of the R type.

put

fun Route.put(body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match PUT requests.

@JvmName(name = "putTyped")

inline fun <R : Any> Route.put(crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match PUT requests receiving a request body as content of the R type.

fun Route.put(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route

Builds a route to match PUT requests with the specified path.

@JvmName(name = "putTypedPath")

inline fun <R : Any> Route.put(path: String, crossinline body: suspend <ERROR CLASS><Unit, ApplicationCall>.(R) -> Unit): Route

Builds a route to match PUT requests with the specified path receiving a request body as content of the R type.

route

fun Route.route(path: String, build: Route.() -> Unit): Route

Builds a route to match the specified path.

fun Route.route(path: String, method: <ERROR CLASS>, build: Route.() -> Unit): Route

Builds a route to match the specified HTTP method and path.

routing

fun Application.routing(configuration: Routing.() -> Unit): Routing

Installs a Routing plugin for the this Application and runs a configuration script on it. You can learn more about routing in Ktor from Routing.

Properties

application

val Route.application: Application

Gets an Application for this Route by scanning the hierarchy to the root.

IgnoreTrailingSlash

val IgnoreTrailingSlash: ApplicationPlugin<Unit>

A plugin that enables ignoring a trailing slash when resolving URLs.

RoutingFailureStatusCode

val RoutingFailureStatusCode: <ERROR CLASS><<ERROR CLASS>>