error_handlers
app.error_handlers
Módulo con funciones para manejar excepciones en las solicitudes a FastApi
Para más información, te recomendamos leer la documentación del Proyecto.
- https://fastapi.tiangolo.com/tutorial/handling-errors/
- https://fastapi.tiangolo.com/how-to/custom-request-and-route/
- https://www.starlette.io/requests/
not_found(request, exc)
async
Se encarga de devolver una respuesta JSON por defecto, cuando no se encuentra el recurso solicitado.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | Exception | la excepcion generada | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples:
request_entity_too_large(request, exc)
async
Para GAE/Cloud Run, cuando la solicitud es más grande de lo que el servidor quiere o puede servir.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | Exception | la excepcion generada | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples:
infernal_server_error(request, exc)
async
Se encarga de devolver las respuestas en JSON por defecto, cuando se lanza una HTTPException, para prevenir que el BackEnd genere un error 500x.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | Exception | la excepcion generada | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples:
validation_exception_handler(request, exc)
async
Sobreescribe algunos errores de fastapi (Ej. 422) por mensajes acordes a la estructura de respuestas del BackEnd.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | RequestValidationError | la excepcion generada cuando una solicitud contiene datos no válidos | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples:
not_allowed(request, exc)
async
Se encarga de devolver una respuesta JSON por defecto, cuando el recurso solicitado no está permitido, normalmente generado por APIRouter.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | Exception | la excepcion generada | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples:
custom_http_exceptions(request, exc)
async
Sobreescribe algunos errores de fastapi generados por excepciones personalizadas y por HTTPException
, con mensajes acordes a la estructura de respuestas del BackEnd.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request | Request | una instancia de | required |
exc | Exception | HTTPException | la excepcion generada cuando se genera una excepción | required |
Returns:
Type | Description |
---|---|
Any | un objeto de tipo ORJSONResponse |
Examples: