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

来源：恩氏滤油机

时间：2024-09-23

浏览量：0

使用 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：每个待办事项的**标识符。

标题：待办事项的主要内容。

描述：其他详细信息（可选）。

completed：待办事项的布尔状态（无论是否完成）。

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