如何在 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 可讓您更好地控制各個路線，並且對於處理路線內的特定情況很有用。