Saltar a contenido

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.

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 Request para las conexiones HTTP entrantes

required
exc Exception

la excepcion generada

required

Returns:

Type Description
Any

un objeto de tipo ORJSONResponse

Examples:

...
fastapi.add_exception_handler(404, not_found)

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 Request para las conexiones HTTP entrantes

required
exc Exception

la excepcion generada

required

Returns:

Type Description
Any

un objeto de tipo ORJSONResponse

Examples:

...
fastapi.add_exception_handler(413, request_entity_too_large)

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 Request para las conexiones HTTP entrantes

required
exc Exception

la excepcion generada

required

Returns:

Type Description
Any

un objeto de tipo ORJSONResponse

Examples:

...
fastapi.add_exception_handler(500, infernal_server_error)

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 Request para las conexiones HTTP entrantes

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:

...
fastapi.add_exception_handler(RequestValidationError, validation_exception_handler)

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 Request para las conexiones HTTP entrantes

required
exc Exception

la excepcion generada

required

Returns:

Type Description
Any

un objeto de tipo ORJSONResponse

Examples:

...
fastapi.add_exception_handler(405, not_allowed)

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 Request para las conexiones HTTP entrantes

required
exc Exception | HTTPException

la excepcion generada cuando se genera una excepción

required

Returns:

Type Description
Any

un objeto de tipo ORJSONResponse

Examples:

...
fastapp.add_exception_handler(HTTPException, custom_http_exceptions)