Application configuration documentation

main.py

Main application

src.main.custom_openapi()

Sets up a custom OpenAPI Specification from a YAML file.

Returns:

Custom OpenAPI specification

Return type:

dict

src.main.lifespan(_app: FastAPI)

Define actions to be performed before and after application execution.

Parameters:

_app (FastAPI) – FastAPI application.

async src.main.request_validation_exception_handler(_request: Request, _exc: RequestValidationError)

Exception handler for the “RequestValidationError” error raised when a bad request is sent to an endpoint.

Returns:

A plain-text response explaining what might have caused the error.

Return type:

PlainTextResponse