Create a route to match 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

Create a route to match the port on which the call was received.

method

fun Route.method(method: HttpMethod, body: Route.() -> Unit): Route

Builds a route to match specified method

optionalParam

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

Builds a route to optionally capture 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 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 parameter with specified name and value

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

Builds a route to match parameter with specified name and capture its value

patch

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

Builds a route to match PATCH requests with 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 request body content of type R

@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 specified path receiving request body content of type R

port

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

Create a route to match request port.

post

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

Builds a route to match POST requests with 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 request body content of type R

@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 specified path receiving request body content of type R

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 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 with receiving request body content of type R

@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 specified path receiving request body content of type R

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 specified path

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

Builds a route to match specified method and path

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