API

APIHandler

class usernado.api.APIHandler(application: Application, request: HTTPServerRequest, **kwargs: Any)

Every API handler MUST inherit from APIHandler.

Actually APIHandler is a WebHandler with extra methods. To use API functionalities you can decorate APIHandler inherited classes with api_route decorator.

get_json_argument(name: str, default: Optional[str] = None) → str

Get json argument from incoming request.

Parameters

name (str) – Name of the argument.
default (str, optional) – Default value for argument if not presented, defaults to None

Raises

DataMalformedOrNotProvidedError –

Returns

Particular JSON argument that comes with current request.

Return type

str

get_json_arguments() → Dict[Any, Any]

Get all json arguments from incoming request.

Raises: DataMalformedOrNotProvidedError –
Returns: All JSON argument that comes with current request
Return type: Dict[Any, Any]

response(message: Optional[Dict[str, Union[str, bytes]]] = None, headers: Optional[Dict[str, str]] = None, status_code: int = 200) → None

Send JSON response to the client.

Parameters

message (_Message) – Response body.
headers (Optional[Dict[str, str]], optional) – Response headers, defaults to None
status_code (int, optional) – Response status code, defaults to 200

Exceptions

exception usernado.api.DataMalformedOrNotProvidedError