FastAPI 中如何使用 HTTPException？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

在 FastAPI 中，HTTPException 是用于处理 HTTP 错误响应的异常类。你可以通过抛出 HTTPException 来返回特定的 HTTP 状态码和错误信息。以下是一个简单的示例：

// www.javascriptcn.com code example
from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id != 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

在这个示例中，如果 item_id 不等于 42，FastAPI 会抛出一个 HTTPException，并返回 404 状态码和错误信息 "Item not found"。

本题详细解读

1. HTTPException 的作用

HTTPException 是 FastAPI 提供的一个异常类，专门用于处理 HTTP 错误响应。它允许你在代码中抛出异常，并指定返回的 HTTP 状态码和错误信息。

2. 使用 HTTPException 的步骤

导入 HTTPException：首先需要从 fastapi 模块中导入 HTTPException。
```
from fastapi import HTTPException
```
抛出异常：在需要返回错误响应的位置，使用 raise 关键字抛出 HTTPException，并指定 status_code 和 detail 参数。
```
raise HTTPException(status_code=404, detail="Item not found")
```
- status_code：指定返回的 HTTP 状态码，例如 404 表示资源未找到。
- detail：指定返回的错误信息，通常是一个字符串。
处理异常：FastAPI 会自动捕获 HTTPException，并将其转换为对应的 HTTP 响应。

3. 自定义错误响应

你还可以通过 HTTPException 返回自定义的错误响应，例如包含更多信息的 JSON 对象：

raise HTTPException(
    status_code=400,
    detail={
        "error": "Invalid input",
        "message": "The provided input is not valid."
    }
)

在这个示例中，返回的错误响应将包含一个 JSON 对象，其中包含 error 和 message 字段。

4. 使用场景

HTTPException 通常用于以下场景：

资源未找到：当请求的资源不存在时，返回 404 状态码。
权限不足：当用户没有权限访问某个资源时，返回 403 状态码。
输入验证失败：当用户提供的输入不符合要求时，返回 400 状态码。

通过使用 HTTPException，你可以轻松地在 FastAPI 应用中处理各种 HTTP 错误情况，并返回适当的错误响应。