Hearken Documentation Beta

Structure HTTPRequest

public struct HTTPRequest: Equatable

A simplified model for HTTP requests.

Conforms To

Equatable

Initializers

init(method:​uri:​headers:​body:​)

public init(method: HTTPMethod, uri: String, headers: HTTPHeaders = [], body: HTTPBody? = nil)

Creates an instance of HTTPRequest.

Parameters

method HTTPMethod
  • method: HTTP request method eg. POST.
uri String
  • uri: HTTP request URI eg. /api/test.
headers HTTPHeaders
  • headers: HTTP request headers eg. Content-Type: application/json. Defaults to empty.
body HTTPBody?
  • body: HTTP request body. Defaults to nil.

Properties

method

let method: HTTPMethod

HTTP request method eg. POST.

uri

let uri: String

HTTP request URI eg. /api/test.

headers

let headers: HTTPHeaders

HTTP request headers eg. Content-Type: application/json.

body

let body: HTTPBody?

HTTP request body.

route

var route: HTTPRoute