Skip to content
module

handler.server.api

</>

Defines how the API will handle requests.

Functions
  • handle_request(req_model, request) (dict) — Defines actions to be taken when a post request is made to the root page.</>
  • read_root(request) (dict) — Defines actions to be taken when a get request is made to the root page.</>
  • run() — Run the server.</>
  • swagger_ui_html() (HTMLResponse) — Returns a swagger html.</>
  • user_login(user) (dict) — Returns a JWE if the user is authenticated.</>
function

handler.server.api.swagger_ui_html()

</>

Returns a swagger html.

Returns (HTMLResponse)

A HTMLResponse containing the UI specified in the OpenAPI specification.

function

handler.server.api.user_login(user=Body(PydanticUndefined))

</>

Returns a JWE if the user is authenticated.

Parameters
  • user (UserLoginSchema) — User login object.
Returns (dict)

A JWE response signed.

Raises
  • HTTPException — If user fails to authenticate.
function

handler.server.api.read_root(request)

</>

Defines actions to be taken when a get request is made to the root page.

Parameters
  • request (Request) — User request object.
Returns (dict)

Dictionary containing the request parameters.

function

handler.server.api.handle_request(req_model, request)

</>

Defines actions to be taken when a post request is made to the root page.

Parameters
  • req_model (RequestModel) — User request object.
  • request (Request) — FastAPI request object.
Returns (dict)

Dictionary containing the response.

Raises
  • HTTPException — When the handler raises any Exception.
function

handler.server.api.run()

</>

Run the server.