首页 > 后端开发 > Python教程 > 如何在 FastAPI 中自定义错误响应?

如何在 FastAPI 中自定义错误响应?

DDD
发布: 2024-10-21 06:32:29
原创
965 人浏览过

How to Customise Error Responses in FastAPI?

在 FastAPI 中自定义错误响应

收到无效的 JSON 请求时,FastAPI 通常会返回 422 无法处理的实体错误,并包含有关该问题的详细信息。但是,可以使用您自己的消息和结构自定义此错误响应。

处理此问题的一种方法是覆盖默认的请求验证异常处理程序。这可以通过实现自定义异常处理程序装饰器来完成。以下是修改错误响应以包含自定义消息的示例:

<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

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"}
        }),
    )

class Demo(BaseModel):
    content: str = None

@app.post("/demo")
async def demo_func(d: Demo):
    return d.content</code>
登录后复制

此异常处理程序将返回带有自定义消息的 JSON 响应,以及原始验证错误和请求正文。

或者,您可以将错误响应自定义为纯文本消息:

<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>
登录后复制

此处理程序将输出表示错误消息的简单纯文本字符串。这两种方法都允许您自定义错误响应,以便为您的 API 用户提供更加用户友好或上下文特定的消息。

以上是如何在 FastAPI 中自定义错误响应?的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:php
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板