发挥 FastAPI 的威力，响应模型和错误处理保驾护航

2023-09-10 16:13:03

响应模型

响应模型是在FastAPI中定义的，用于定义你的API返回的JSON数据。响应模型可以使用各种不同的数据类型，包括原始类型、列表和字典等。

创建响应模型

要创建一个响应模型，可以使用@dataclasses.dataclass装饰器。该装饰器会创建一个新的类，该类可以被用作响应模型。例如：

from dataclasses import dataclass

@dataclass
class Todo:
    id: int
    title: str
    description: str

这个类可以被用作返回一个待办事项的响应模型。要使用它，只需在你的路由处理函数中返回一个Todo实例即可。

错误处理

FastAPI提供了许多内置的错误处理函数，你可以使用它们来处理你的API中可能发生的错误。这些错误处理函数包括：

@app.exception_handler()装饰器：该装饰器可以让你定义一个错误处理函数来处理特定的错误。
@app.error_handler_for_status()装饰器：该装饰器可以让你定义一个错误处理函数来处理特定状态码的错误。
raise你可以使用raise来显式抛出一个错误。

使用错误处理函数

要使用错误处理函数，只需在你的路由处理函数中调用它们即可。例如：

from fastapi import HTTPException

@app.get("/todos/{todo_id}")
async def get_todo(todo_id: int):
    try:
        todo = await get_todo_from_database(todo_id)
    except HTTPException as e:
        return e
    return todo

这个路由处理函数会先尝试从数据库中获取一个待办事项。如果获取失败，它会抛出一个HTTPException错误。然后，该错误会被错误处理函数处理，并返回给客户端。

HTTP 状态码

HTTP 状态码是用来表示HTTP请求或响应的状态。常用的HTTP状态码包括：

200 OK：请求成功。
400 Bad Request：请求无效。
404 Not Found：请求的资源不存在。
500 Internal Server Error：服务器内部错误。

你可以在你的路由处理函数中使用status_code参数来指定返回的HTTP状态码。例如：

@app.get("/todos/{todo_id}")
async def get_todo(todo_id: int):
    try:
        todo = await get_todo_from_database(todo_id)
    except HTTPException as e:
        return e
    return todo, status_code=200