使用 FastAPI 构建 Todo API 的部分：分步指南

使用 FastAPI 构建 Todo API：分步指南

代码可以在这里找到：GitHub - jamesbmour/blog_tutorials：

一、简介

在上一篇文章中，我们介绍了 FastAPI 并建立了基本的项目结构。现在，我们将更进一步，构建一个功能性的 Todo API。在本教程结束时，您将拥有一个可以创建、读取、更新和删除待办事项的工作后端。

我们将涵盖的内容：

• 设计 Todo 数据模型
• 实现CRUD操作
• 创建 API 端点
• 添加输入验证和错误处理
• 测试 API
• 重构和组织代码

二.设计 Todo 数据模型

为了管理待办事项，我们必须定义一个表示待办事项的数据模型。 FastAPI 使用 Pydantic 模型来验证和解析数据，因此我们将在这里利用它。

A. 定义 Todo 模式

我们将使用 Pydantic 创建两个模型：

• TodoCreate：用于创建或更新待办事项时的输入数据。
• Todo：用于完整的待办事项，包括 id 和created_at 等字段。

from pydantic import BaseModel
from typing import Optional
from datetime import datetime

class TodoCreate(BaseModel):
    title: str
    description: Optional[str] = None
    completed: bool = False

class Todo(BaseModel):
    id: str
    title: str
    description: Optional[str] = None
    completed: bool
    created_at: datetime

B. 解释字段

• id：每个待办事项的唯一标识符。
• 标题：待办事项的主要内容。
• 描述：其他详细信息（可选）。
• 已完成：待办事项的布尔状态（无论是否完成）。
• created_at：指示待办事项创建时间的时间戳。

三．为 Todos 创建 CRUD 操作

CRUD 代表创建、读取、更新和删除——管理数据的四个基本操作。在本教程中，我们将使用内存数据库（一个简单的列表）来实现这些操作。

A. 设置内存数据库

我们将使用一个列表来存储我们的待办事项。为了简单起见，我们还将添加一些示例待办事项。

from uuid import uuid4
from datetime import datetime

todos = [
    {
        "id": str(uuid4()),
        "title": "Learn FastAPI",
        "description": "Go through the official FastAPI documentation and tutorials.",
        "completed": False,
        "created_at": datetime.now(),
    },
    {
        "id": str(uuid4()),
        "title": "Build a Todo API",
        "description": "Create a REST API for managing todo items using FastAPI.",
        "completed": False,
        "created_at": datetime.now(),
    },
    {
        "id": str(uuid4()),
        "title": "Write blog post",
        "description": "Draft a blog post about creating a Todo API with FastAPI.",
        "completed": False,
        "created_at": datetime.now(),
    },
]

B. 实现辅助函数

我们将实现一个简单的辅助函数来通过 id 查找待办事项。

def get_todo_by_id(todo_id: str):
    for todo in todos:
        if todo["id"] == todo_id:
            return todo
    return None

四．实施 API 端点

A. 创建新的待办事项

POST 端点允许用户创建新的待办事项。

@app.post("/todos/", response_model=Todo)
def create_todo(todo: TodoCreate):
    new_todo = Todo(
        id=str(uuid4()),
        title=todo.title,
        description=todo.description,
        completed=todo.completed,
        created_at=datetime.now()
    )
    todos.append(new_todo.dict())
    return new_todo

B. 检索所有待办事项

GET 端点从我们的内存数据库中检索所有待办事项。

@app.get("/todos/", response_model=List[Todo])
def get_all_todos():
    return todos

C. 检索单个待办事项

GET 端点允许通过 ID 检索单个待办事项。

@app.get("/todos/{todo_id}", response_model=Todo)
def get_todo(todo_id: str):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    return todo

D. 更新待办事项

PUT 端点允许用户更新现有的待办事项。

@app.put("/todos/{todo_id}", response_model=Todo)
def update_todo(todo_id: str, todo_data: TodoCreate):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    todo["title"] = todo_data.title
    todo["description"] = todo_data.description
    todo["completed"] = todo_data.completed
    return Todo(**todo)

E. 删除待办事项

DELETE 端点允许用户通过其 id 删除待办事项。

@app.delete("/todos/{todo_id}")
def delete_todo(todo_id: str):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    todos.remove(todo)
    return {"detail": "Todo deleted successfully"}

V. 添加输入验证和错误处理

A. 使用 Pydantic 进行输入验证

FastAPI 自动根据我们定义的 Pydantic 模型验证输入数据。这确保数据在处理之前符合我们预期的模式。

B. 自定义错误处理

我们可以通过添加异常处理程序来自定义错误响应。

@app.exception_handler(HTTPException)
def http_exception_handler(request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={"detail": exc.detail},
    )

六．测试 API

FastAPI 附带交互式 Swagger UI 文档，可以轻松测试您的 API 端点。只需运行应用程序并在浏览器中导航至 /docs。

测试示例

• 创建待办事项：通过创建新的待办事项来测试 POST 端点。
• 检索待办事项：使用 GET 端点获取所有待办事项或按 id 获取特定待办事项。
• 更新和删除：测试 PUT 和 DELETE 端点以更新或删除待办事项。

七．重构和组织代码

随着应用程序的增长，保持代码的组织性至关重要。这里有一些提示：

A. 将模型移动到单独的文件

您可以将 Pydantic 模型移动到 models.py 文件中，以保持主应用程序文件干净。

B. 为 Todo 端点创建路由器

考虑为待办事项相关端点创建一个单独的路由器，尤其是随着您的 API 的增长。

八．下一步

在下一篇文章中，我们将把一个真实的数据库（如 SQLite 或 PostgreSQL）集成到我们的 FastAPI 应用程序中。我们还将研究用户身份验证和更高级的功能。

建议的改进：

• 向 GET 端点添加过滤和分页。
• 实施用户身份验证来管理个人待办事项。

九．结论

在本教程中，我们使用 FastAPI 构建了一个简单的 Todo API。我们首先设计一个数据模型，实现 CRUD 操作，并创建端点来管理待办事项。我们还涉及输入验证、错误处理和测试。有了这个基础，您可以进一步扩展 API 或将其与前端集成以创建成熟的应用程序。

如果你想支持我的写作或给我买瓶啤酒：
https://buymeacoffee.com/bmours

以上是使用 FastAPI 构建 Todo API 的部分：分步指南的详细内容。更多信息请关注PHP中文网其他相关文章！