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.

insertPhaseAfter

fun insertPhaseAfter(reference: PipelinePhase, phase: PipelinePhase)

insertPhaseAfter

fun Route.~~insertPhaseAfter~~(reference: PipelinePhase, phase: PipelinePhase)

insertPhaseBefore

fun insertPhaseBefore(reference: PipelinePhase, phase: PipelinePhase)

insertPhaseBefore

fun Route.~~insertPhaseBefore~~(reference: PipelinePhase, phase: PipelinePhase)

install

open override fun <B : Any, F : Any> install(plugin: Plugin<ApplicationCallPipeline, B, F>, configure: B.() -> Unit): F

Installs a plugin into this route, if it is not yet installed.

intercept

fun intercept(phase: PipelinePhase, block: PipelineInterceptor<Unit, PipelineCall>)

intercept

fun Route.~~intercept~~(phase: PipelinePhase, block: suspend PipelineContext<Unit, PipelineCall>.(Unit) -> Unit)

interceptor

suspend fun interceptor(context: PipelineContext<Unit, PipelineCall>)

interceptorsForPhase

fun interceptorsForPhase(phase: PipelinePhase): List<PipelineInterceptor<Unit, PipelineCall>>

invoke

operator fun invoke(body: RoutingNode.() -> Unit)

Allows using a route instance for building additional routes.

localPort

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

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

merge

fun merge(from: Pipeline<Unit, PipelineCall>)

mergePhases

fun mergePhases(from: Pipeline<Unit, PipelineCall>)

method

fun Route.method(method: HttpMethod, 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: RoutingHandler): Route

Builds a route to match OPTIONS requests.

fun Route.options(path: String, body: RoutingHandler): Route

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

fun Route.options(path: Regex, body: RoutingHandler): Route

Builds a route to match OPTIONS requests with the specified regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

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: RoutingHandler): Route

Builds a route to match PATCH requests.

@JvmName(name = "patchTyped")

inline fun <R : Any> Route.patch(crossinline body: suspend RoutingContext.(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: RoutingHandler): 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 RoutingContext.(R) -> Unit): Route

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

fun Route.patch(path: Regex, body: RoutingHandler): Route

Builds a route to match PATCH requests with the specified regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

@JvmName(name = "patchTypedPath")

inline fun <R : Any> Route.patch(path: Regex, crossinline body: suspend RoutingContext.(R) -> Unit): Route

Builds a route to match PATCH requests with the specified regex path receiving a request body as content of the R type. Named parameters from regex can be accessed via ApplicationCall.parameters.

plugin

open override fun <F : Any> plugin(plugin: Plugin<*, *, F>): F

Gets a plugin instance for this pipeline, or fails with MissingApplicationPluginException if the plugin is not installed.

port

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

Creates a route to match a request port.

post

fun Route.post(body: RoutingHandler): Route

Builds a route to match POST requests.

@JvmName(name = "postTyped")

inline fun <R : Any> Route.post(crossinline body: suspend RoutingContext.(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: RoutingHandler): 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 RoutingContext.(R) -> Unit): Route

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

fun Route.post(path: Regex, body: RoutingHandler): Route

Builds a route to match POST requests with the specified regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

@JvmName(name = "postTypedPath")

inline fun <R : Any> Route.post(path: Regex, crossinline body: suspend RoutingContext.(R) -> Unit): Route

Builds a route to match POST requests with the specified regex path receiving a request body as content of the R type. Named parameters from regex can be accessed via ApplicationCall.parameters.

preCompressed

fun Route.preCompressed(vararg types: CompressedFileType = CompressedFileType.entries.toTypedArray(), configure: Route.() -> Unit)

Support pre-compressed files and resources

put

fun Route.put(body: RoutingHandler): Route

Builds a route to match PUT requests.

@JvmName(name = "putTyped")

inline fun <R : Any> Route.put(crossinline body: suspend RoutingContext.(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: RoutingHandler): 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 RoutingContext.(R) -> Unit): Route

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

fun Route.put(path: Regex, body: RoutingHandler): Route

Builds a route to match PUT requests with the specified regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

@JvmName(name = "putTypedPath")

inline fun <R : Any> Route.put(path: Regex, crossinline body: suspend RoutingContext.(R) -> Unit): Route

Builds a route to match PUT requests with the specified regex path receiving a request body as content of the R type. Named parameters from regex can be accessed via ApplicationCall.parameters.

resetFrom

fun resetFrom(from: Pipeline<Unit, PipelineCall>)

resource

fun Route.~~resource~~(remotePath: String, resource: String = remotePath, resourcePackage: String? = null)

Sets up routing to serve resource as remotePath in resourcePackage

resources

fun Route.~~resources~~(resourcePackage: String? = null)

Sets up routing to serve all resources in resourcePackage

route

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

Builds a route to match the specified path.

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

Builds a route to match the specified regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

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

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

fun Route.route(path: Regex, method: HttpMethod, build: Route.() -> Unit): Route

Builds a route to match the specified HTTP method and regex path. Named parameters from regex can be accessed via ApplicationCall.parameters.

singlePageApplication

fun Route.singlePageApplication(configBuilder: SPAConfig.() -> Unit = {})

Serves a single-page application. You can learn more from Serving single-page applications.

static

fun Route.~~static~~(configure: Route.() -> Unit): Route

Create a block for static content

fun Route.~~static~~(remotePath: String, configure: Route.() -> Unit): Route

Create a block for static content at specified remotePath

staticFiles

fun Route.staticFiles(remotePath: String, dir: File, index: String? = "index.html", block: StaticContentConfig<File>.() -> Unit = {}): Route

Sets up RoutingRoot to serve static files. All files inside dir will be accessible recursively at "remotePath/path/to/file". If the requested file is a directory and index is not null, then response will be index file in the requested directory.

staticFileSystem

fun Route.staticFileSystem(remotePath: String, basePath: String?, index: String? = "index.html", fileSystem: FileSystemPaths = FileSystems.getDefault().paths(), block: StaticContentConfig<Path>.() -> Unit = {}): Route

Sets up RoutingRoot to serve fileSystem as static content. All paths inside basePath will be accessible recursively at "remotePath/path/to/resource". If requested path doesn't exist and index is not null, then response will be index path in the requested package.

staticResources

fun Route.staticResources(remotePath: String, basePackage: String?, index: String? = "index.html", block: StaticContentConfig<URL>.() -> Unit = {}): Route

Sets up RoutingRoot to serve resources as static content. All resources inside basePackage will be accessible recursively at "remotePath/path/to/resource". If requested resource doesn't exist and index is not null, then response will be index resource in the requested package.

staticZip

fun Route.staticZip(remotePath: String, basePath: String?, zip: Path, index: String? = "index.html", block: StaticContentConfig<Path>.() -> Unit = {}): Route

Sets up RoutingRoot to serve contents of zip as static content. All paths inside basePath will be accessible recursively at "remotePath/path/to/resource". If requested path doesn't exist and index is not null, then response will be index path in the requested package.

toString

open override fun toString(): String

trace

open override fun trace(block: (RoutingResolveTrace) -> Unit)

Registers a function used to trace route resolution. Might be useful if you need to understand why a route isn't executed. To learn more, see Tracing routes.