在 FastAPI 中,当遇到无效请求时,通常会响应 422 Unprocessable Entity 错误。此响应可能并不总是符合所需的用户体验。以下是如何自定义错误响应以满足您的应用程序的特定要求。
默认错误响应包括“额外数据”和“实际”数据等详细信息。为了定制此响应,FastAPI 提供了重写请求验证异常处理程序的功能。如下面的代码示例所示,您可以定义自定义处理程序:
<code class="python">from fastapi import FastAPI, Body, Request, status from fastapi.encoders import jsonable_encoder from fastapi.exceptions import RequestValidationError from fastapi.responses import JSONResponse from pydantic import BaseModel app = FastAPI() @app.exception_handler(RequestValidationError) async def validation_exception_handler(request: Request, exc: RequestValidationError): return JSONResponse( status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, content=jsonable_encoder({ "detail": exc.errors(), # optionally include the errors "body": exc.body, "custom msg": "Your error message" }), )</code>
或者,您可以返回带有自定义错误消息的 PlainTextResponse:
<code class="python">from fastapi.responses import PlainTextResponse @app.exception_handler(RequestValidationError) async def validation_exception_handler(request, exc): return PlainTextResponse(str(exc), status_code=422) </code>
这些自定义选项允许即使遇到无效请求,您也可以优雅地处理错误响应并提供用户友好的体验。
以上是如何自定义 FastAPI 的错误响应的详细内容。更多信息请关注PHP中文网其他相关文章!