如何在FastAPI 中自訂特定路由的錯誤回應
在FastAPI 中，您可以透過重寫來自訂特定路由的錯誤回應RequestValidationError 的異常處理程序。這裡有幾個選項：
選項1（簡單）
如果您不介意Header 在OpenAPI 文件中顯示為可選，您可以使用以下程式碼：
from fastapi import Header, HTTPException
@app.post("/")
def some_route(some_custom_header: Optional[str] = Header(None)):
if not some_custom_header:
raise HTTPException(status_code=401, detail="Unauthorized")
return {"some-custom-header": some_custom_header}選項2（自訂異常處理程序）
要讓Header 按OpenAPI 文件中的要求顯示，您可以重寫異常處理程序：
from fastapi import FastAPI, Request, Header, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from fastapi.encoders import jsonable_encoder
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:
# Check for the specific Header in the errors
for err in exc.errors():
if err['loc'][0] == 'header' and err['loc'][1] == 'some-custom-header':
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}),
)
@app.get("/")
def some_route(some_custom_header: str = Header(...)):
return {'some-custom-header': some_custom_header}選項3 （子應用程式）
您可以建立一個子應用程式並將其掛載到主應用程式。這將允許您僅為子應用程式中定義的路由自訂異常處理程序：
from fastapi import FastAPI, Request, Header
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
app = FastAPI()
@app.get('/')
async def main():
return {'message': 'Hello from main API'}
subapi = FastAPI()
@subapi.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
# Custom exception handling
return JSONResponse(content={'401': 'Unauthorized'}, status_code=401)
@subapi.get('/')
async def sub_api_route(some_custom_header: str = Header(...)):
return {'some-custom-header': some_custom_header}
app.mount('/sub', subapi)選項4（自訂APIRouter 和異常處理）
您可以使用自訂APIRouter 類別並在try- except區塊內處理異常：
from fastapi import FastAPI, APIRouter, Response, Request, Header, HTTPException
from fastapi.responses import JSONResponse
from fastapi.exceptions import RequestValidationError
from fastapi.routing import APIRoute
from typing import Callable
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:
# Custom exception handling
raise HTTPException(status_code=401, detail='401 Unauthorized')
return custom_route_handler
app = FastAPI()
router = APIRouter(route_class=ValidationErrorHandlingRoute)
@app.get('/')
async def main():
return {'message': 'Hello from main API'}
@router.get('/custom')
async def custom_route(some_custom_header: str = Header(...)):
return {'some-custom-header': some_custom_header}
app.include_router(router)選擇最適合您的要求的選項。
以上是如何在 FastAPI 中自訂特定路由的錯誤回應？的詳細內容。更多資訊請關注PHP中文網其他相關文章！
