如何在 FastAPI 中自定义特定路由的错误响应

在 FastAPI 中，引发 RequestValidationError 允许您发送自定义错误响应。这对于需要满足特定条件的端点非常有用，例如必需的标头。

选项 1：覆盖默认异常处理程序

此选项允许您覆盖默认异常处理程序RequestValidationError，允许您自定义错误响应。

from fastapi import FastAPI, Request, Header, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()
routes_with_custom_exception = ['/']

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    if request.url.path in routes_with_custom_exception:
        return JSONResponse(content={'401': 'Unauthorized'}, status_code=401)
    
    return JSONResponse(
        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
        content=jsonable_encoder({'detail': exc.errors(), 'body': exc.body}),
    )

选项 2：使用子应用程序

创建子应用程序允许您创建具有自己的异常处理程序的单独 API 实例。这允许您专门为子应用程序自定义错误处理。

from fastapi import FastAPI
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()
subapi = FastAPI()

@subapi.exception_handler(RequestValidationError)
async def validation_exception_handler(exc: RequestValidationError):
    return JSONResponse(content={'401': 'Unauthorized'}, status_code=401)
    
@subapi.get('/')
async def subapi_route(some_custom_header: str = Header(...)):
    return {'some-custom-header': some_custom_header}

app.mount('/sub', subapi)

选项 3：使用自定义 APIRoute 类

此方法允许您使用自定义 APIRoute 类更改特定路由的行为。

from fastapi import FastAPI, APIRouter, Response, Request, Header, HTTPException
from fastapi.exceptions import RequestValidationError

class ValidationErrorHandlingRoute(APIRoute):
    def get_route_handler(self) -> Callable:
        original_route_handler = super().get_route_handler()

        async def custom_route_handler(request: Request) -> Response:
            try:
                return await original_route_handler(request)
            except RequestValidationError as e:
                raise HTTPException(status_code=401, detail='401 Unauthorized')

        return custom_route_handler

app = FastAPI()
router = APIRouter(route_class=ValidationErrorHandlingRoute)

@router.get('/custom')
async def custom_route(some_custom_header: str = Header(...)):
    return {'some-custom-header': some_custom_header}

app.include_router(router)

您应该使用哪个选项？

当您只需要为特定路由自定义错误响应时，选项 1 很容易实现。当您想要对 API 的子区域进行更多控制（例如应用不同的安全策略或异常处理）时，选项 2 适合。选项 3 使您可以更好地控制各个路线，并且对于处理路线内的特定情况很有用。