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.

Properties

application

val application: Application

attributes

val attributes: Attributes

children

val children: List<Route>

List of child routes for this node.

developmentMode

override val developmentMode: Boolean = false

environment

open val environment: ApplicationEnvironment? = null

isEmpty

val isEmpty: Boolean

items

val items: List<PipelinePhase>

parent

val parent: Route?

receivePipeline

val receivePipeline: ApplicationReceivePipeline

Pipeline for receiving content

selector

val selector: RouteSelector

sendPipeline

val sendPipeline: ApplicationSendPipeline

Pipeline for sending content

Extensions

fun Route.accept(contentType: ContentType, build: Route.() -> Unit): Route

Builds a route to match requests with the HttpHeaders.Accept header matching the specified contentType.

application

val Route.application: Application

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

contentType

fun Route.contentType(contentType: ContentType, build: Route.() -> Unit): Route

Builds a route to match requests with the HttpHeaders.ContentType header matching the specified contentType.

createRouteFromPath

fun Route.createRouteFromPath(path: String): Route

Creates a routing entry for specified path.

default

fun Route.default(localPath: String)

fun Route.default(localPath: File)

Specifies localPath as a default file to serve when folder is requested

defaultResource

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

Specifies resource as a default resources to serve when folder is requested

delete

fun Route.delete(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route

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

fun Route.delete(body: PipelineInterceptor<Unit, ApplicationCall>): Route

Builds a route to match DELETE requests.

file

fun Route.file(remotePath: String, localPath: String = remotePath)

fun Route.file(remotePath: String, localPath: File)

Sets up routing to serve localPath file as remotePath

files

fun Route.files(folder: String)

fun Route.files(folder: File)

Sets up routing to serve all files from folder

findPluginInRoute

fun <F : Any> Route.findPluginInRoute(plugin: Plugin<*, *, F>): F?

Finds the plugin F in the current Route. If not found, search in the parent Route.

get

fun Route.get(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route

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

fun Route.get(body: PipelineInterceptor<Unit, ApplicationCall>): Route

Builds a route to match GET requests.

getAllRoutes

fun Route.getAllRoutes(): List<Route>

Return list of endpoints with handlers under this route.

head

fun Route.head(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route

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

fun Route.head(body: PipelineInterceptor<Unit, ApplicationCall>): Route

Builds a route to match HEAD requests.

header

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

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

host

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

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(hostPattern: Regex, port: Int = 0, build: Route.() -> Unit): Route

fun Route.host(hosts: List<String>, ports: List<Int> = emptyList(), 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: 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(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route

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

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

Builds a route to match OPTIONS requests.

param

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

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

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

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

patch

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

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

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

Builds a route to match PATCH requests.

@JvmName(name = "patchTyped")

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

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

@JvmName(name = "patchTypedPath")

inline fun <R : Any> Route.patch(path: String, crossinline body: suspend PipelineContext<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(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route

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

@JvmName(name = "postTyped")

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

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

@JvmName(name = "postTypedPath")

inline fun <R : Any> Route.post(path: String, crossinline body: suspend PipelineContext<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.

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

Builds a route to match POST requests.

preCompressed

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

Support pre-compressed files in the file system only (not just any classpath resource)

put

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

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

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

Builds a route to match PUT requests.

@JvmName(name = "putTyped")

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

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

@JvmName(name = "putTypedPath")

inline fun <R : Any> Route.put(path: String, crossinline body: suspend PipelineContext<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.

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: String, method: HttpMethod, build: Route.() -> Unit): Route

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

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

staticBasePackage

var Route.staticBasePackage: String?

Base package for relative resources calculations for static content

staticRootFolder

var Route.staticRootFolder: File?

Base folder for relative files calculations for static content