FastAPI 覆盖 FastAPI 的 HTTPException 响应体

在本文中，我们将介绍如何通过覆盖 FastAPI 的 HTTPException 响应体来自定义错误消息和格式。

什么是 FastAPI 的 HTTPException？

FastAPI 是一个用于构建 Web 应用程序和 API 的现代、快速（高性能）、基于标准 Python 类型提示的 Web 框架。它内置了一个异常类 HTTPException，用于处理 HTTP 请求中出现的错误。例如，当找不到请求的资源时，FastAPI 会抛出一个 404 错误的 HTTPException。

默认的 HTTPException 响应体

FastAPI 的 HTTPException 默认返回一个 JSON 对象，其中包含以下内容：
– “detail”：错误的描述
– “error”：错误的类型
– “status_code”：HTTP 状态码

以下是一个示例，默认的 HTTPException 响应体：

{
    "detail": "Not Found",
    "error": "Not Found",
    "status_code": 404
}

覆盖 HTTPException 响应体

如果我们想要自定义错误消息和格式，我们可以通过继承 HTTPException 并覆盖其响应体的方式来实现。

步骤1：继承 HTTPException

首先，我们需要创建一个继承自 HTTPException 的自定义异常类。我们可以在该类中添加我们自定义的错误消息和格式。

以下是一个示例：

from fastapi import HTTPException

class CustomHTTPException(HTTPException):
    def __init__(self, status_code: int, detail: str):
        super().__init__(status_code, detail=detail)
        self.error = "Custom Error"

在上面的示例中，我们创建了一个 CustomHTTPException 类，继承自 HTTPException。我们在该类的构造函数中添加了两个参数：status_code 和 detail。在构造函数中，我们首先调用父类的构造函数来设置 HTTPException 的状态码和错误描述。然后，我们将自定义的错误类型设置为 “Custom Error”。

步骤2：使用自定义异常类

接下来，我们需要在我们的应用程序中使用自定义的异常类。我们可以通过使用 raise 关键字抛出自定义的异常，并传递自定义的错误描述和状态码。

以下是一个示例：

from fastapi import FastAPI
from fastapi.exceptions import HTTPException as FastAPIHTTPException

app = FastAPI()

class CustomHTTPException(FastAPIHTTPException):
    def __init__(self, status_code: int, detail: str):
        super().__init__(status_code, detail=detail)
        self.error = "Custom Error"

@app.get("/example")
def example():
    raise CustomHTTPException(status_code=418, detail="I'm a teapot")

在上面的示例中，我们创建了一个名为 example 的路由，当访问该路由时，会抛出一个状态码为 418 的 CustomHTTPException 异常，并传递了错误描述 “I’m a teapot”。

步骤3：自定义错误处理程序

最后，我们需要为我们的自定义异常添加一个错误处理程序，以便能够自定义错误响应的格式。

以下是一个示例：

from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from starlette.exceptions import HTTPException as StarletteHTTPException

@app.exception_handler(CustomHTTPException)
async def custom_http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"error": exc.error, "detail": exc.detail},
    )

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request, exc):
    return JSONResponse(
        status_code=400,
        content={"error": "Validation Error", "detail": str(exc)},
    )

@app.exception_handler(StarletteHTTPException)
async def starlette_http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"error": "Starlette HTTPException", "detail": exc.detail},
    )

在上面的示例中，我们为 CustomHTTPException、RequestValidationError 和 StarletteHTTPException 分别定义了错误处理程序。在这些处理程序中，我们可以自定义每个异常的响应格式。在本例中，我们使用 JSONResponse 返回一个 JSON 对象，其中包含自定义的错误消息和格式。

总结

通过覆盖 FastAPI 的 HTTPException 响应体，我们可以自定义错误消息和格式，以满足我们的特定需求。我们可以创建一个继承自 HTTPException 的自定义异常类，并在其中定义自己的错误描述和格式。然后，我们可以在应用程序中使用自定义异常类，并为其添加自定义的错误处理程序，以自定义错误响应的格式。

这样，我们就能够更好地控制和定制我们的 FastAPI 应用程序中出现的错误信息和响应体。希望本文对您有所帮助！