Share via

HttpRequest Class

An HTTP request object.

Constructor

HttpRequest(method: str, url: str, *, headers: Mapping[str, str] | None = None, params: Mapping[str, str] | None = None, route_params: Mapping[str, str] | None = None, body: bytes)

Parameters

Name Description
method
Required
str

HTTP request method name.
url
Required
str

HTTP URL.
headers
Required
dict

An optional mapping containing HTTP request headers.
params
Required
dict

An optional mapping containing HTTP request params.
route_params
Required
dict

An optional mapping containing HTTP request route params.
body
Required
bytes

HTTP request body.

Keyword-Only Parameters

Name Description
headers
Default value: None
params
Default value: None
route_params
Default value: None
body
Required

Methods

get_body
get_json

get_body 

get_body() -> bytes

get_json 

get_json() -> Any

Attributes

files

form

headers

method

params

route_params

url