从构建框架到使用 Python 与 FastAPI 编写待办事项应用指南

2023-11-26 05:33:05

使用 FastAPI 搭建 RESTful API：实现待办事项管理

构建高效且易于维护的 RESTful API 对于现代应用程序至关重要。FastAPI ，一个基于 Python 的 Web 框架，因其高性能、简便性，以及丰富的特性而备受推崇，为快速开发 RESTful API 提供了理想的选择。

创建项目

建立虚拟环境： 创建一个与系统环境隔离的开发环境，确保依赖关系得到管理。

python3 -m venv venv
source venv/bin/activate

安装 FastAPI： 使用 pip 安装 FastAPI。

pip install fastapi

创建项目目录： 创建项目目录并导航至其中。

mkdir todo-app
cd todo-app
touch main.py

数据建模

Pydantic 提供了一个强大的数据验证库，可用于定义 API 数据模型，确保数据的一致性和有效性。

from pydantic import BaseModel

class Todo(BaseModel):
    id: int
    title: str
    description: str

编写 CRUD 路由

创建、读取、更新和删除（CRUD）操作是 RESTful API 的核心功能。FastAPI 提供了一个直观的路由机制来实现这些操作。

# 创建待办事项
@app.post("/todos")
async def create_todo(todo: Todo):
    # 保存待办事项至数据库
    return Todo(id=1, title=todo.title, description=todo.description)

# 读取待办事项
@app.get("/todos")
async def get_todos():
    # 从数据库获取待办事项列表
    return [{"id": 1, "title": "Learn FastAPI", "description": "Build a RESTful API using FastAPI"}]

# 更新待办事项
@app.put("/todos/{todo_id}")
async def update_todo(todo_id: int, todo: Todo):
    # 从数据库获取待办事项
    # 更新待办事项
    # 保存待办事项至数据库
    return Todo(id=todo_id, title=todo.title, description=todo.description)

# 删除待办事项
@app.delete("/todos/{todo_id}")
async def delete_todo(todo_id: int):
    # 从数据库获取待办事项
    # 删除待办事项
    return {"message": "Todo deleted successfully"}