kobweb-api/com.varabyte.kobweb.api.http/Request

Request

interface Request(source)

Information passed into an API endpoint from the client.

The request information will be passed in via an ApiContext. Developers implementing an API endpoint can read request values with code like the following:

@Api
suspend fun echo(ctx: ApiContext) {
  val msg = ctx.req.params["msg"]
  if (msg != null) {
    ctx.res.body = Body.text("Received message: $msg")
  }
  else {
    ctx.res.status = 400
    ctx.res.body = Body.text("Missing: required parameter 'msg'")
  }
}

See also

Inheritors

Types

class Connection(val origin: Request.Connection.Details, val local: Request.Connection.Details)

Top-level container class for views about a connection for some request.

Properties

abstract val body: Body?

The body payload sent with the request.

abstract val connection: Request.Connection

Information about the connection that carried the request.

abstract val cookies: Map<String, String>

Any cookies sent with the request.

abstract val data: Data

A holder of user data that can be added to this request.

abstract val headers: Map<String, List<String>>

All headers sent with the request.

abstract val method: HttpMethod

The type of http method this call was sent with.

abstract val params: Map<String, String>

A list of key/value pairs extracted either from the user's query string or from any dynamic path parts.

abstract val queryParams: Map<String, String>

Like params but only for the query string.

Functions

suspend fun Request.~~readBodyText~~(): String?