Package-level declarations

Types

Link copied to clipboard

Singleton Koven server instance.

Link copied to clipboard

A builder context for configuring routes and server settings.

Link copied to clipboard

Configuration for the KovenServer.

Properties

Link copied to clipboard
val HttpMethod.toHttp4k: Method

Functions

Link copied to clipboard
fun Response.cookie(cookie: Cookie): Response

Attaches a Koven Cookie to the org.http4k.core.Response.

Link copied to clipboard
context(_: Raise<Issue>)
operator fun <T> Request.get(field: CookieField<T>): T

Gets a cookie from the org.http4k.core.Request by its field.

Link copied to clipboard
inline fun <Req, Res, ReqH, ResH, PathP, QueryP, CookieP> ApiContract<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>.register(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>.(Req, PathP, QueryP) -> ApiResponse<Res, ResH>): RoutingHttpHandler

Creates a route for the given ApiContract.

@JvmName(name = "registerSimple")
inline fun <Req, Res, ReqH, ResH, CookieP> ApiContract<Req, Res, ReqH, ResH, Empty, Empty, CookieP>.register(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Req, Res, ReqH, ResH, Empty, Empty, CookieP>.(Req) -> ApiResponse<Res, ResH>): RoutingHttpHandler

Simplifies registration for ApiContract types with no path or query parameters.

@JvmName(name = "registerUnit")
inline fun <Req, ReqH, PathP, QueryP, CookieP> ApiContract<Req, Unit, ReqH, Empty, PathP, QueryP, CookieP>.register(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Req, Unit, ReqH, Empty, PathP, QueryP, CookieP>.(Req, PathP, QueryP) -> Unit): RoutingHttpHandler

Overload for register that allows returning Unit when the response body is Unit and headers are Empty.

@JvmName(name = "registerSimpleUnit")
inline fun <Req, ReqH, CookieP> ApiContract<Req, Unit, ReqH, Empty, Empty, Empty, CookieP>.register(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Req, Unit, ReqH, Empty, Empty, Empty, CookieP>.(Req) -> Unit): RoutingHttpHandler

Overload for register (simple) that allows returning Unit when the response body is Unit and headers are Empty.

Link copied to clipboard
inline fun <Res, ReqH, ResH, PathP, QueryP, CookieP> ApiContract<Multipart, Res, ReqH, ResH, PathP, QueryP, CookieP>.registerMultipart(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Multipart, Res, ReqH, ResH, PathP, QueryP, CookieP>.(Multipart, PathP, QueryP) -> ApiResponse<Res, ResH>): RoutingHttpHandler

Creates a route for the given ApiContract with a multipart request body.

Link copied to clipboard
inline fun <Req, T, ReqH, ResH, PathP, QueryP, CookieP> ApiContract<Req, PaginatedResponse<T>, ReqH, ResH, PathP, QueryP, CookieP>.registerPaginated(filter: Filter = Filter.NoOp, crossinline handler: context(Request, Raise<Issue>, ReqH, CookieP, Principal) ApiContract<Req, PaginatedResponse<T>, ReqH, ResH, PathP, QueryP, CookieP>.(Req, PathP, QueryP, Pagination) -> ApiResponse<List<T>, ResH>): RoutingHttpHandler

Creates a route for the given ApiContract that returns a paginated response with a Pagination context.