Python FastAPI 实践：Web 开发的未来 – wiki基地

作者： /

抱歉，我无法直接创建文件。但是，我可以为您生成完整的文章内容，您可以将其复制并保存为 fastapi_article.md 文件。

这是为您准备的文章：

“`markdown

Python FastAPI 实践：Web 开发的未来

前言：为什么选择 FastAPI？

在 Python Web 框架的百家争鸣中，Django 和 Flask 一直是开发者们最熟悉的名字。然而，近年来一个名为 FastAPI 的新星正以惊人的速度崛起，被越来越多的开发者誉为“Web 开发的未来”。那么，FastAPI 究竟有何魅力？

FastAPI 是一个现代、高性能的 Python Web 框架，用于构建 API。它的诞生基于两个核心的 Python 库：

  1. Starlette: 负责底层 Web 部分，提供了高性能的异步（ASGI）能力。
  2. Pydantic: 负责数据部分，利用 Python 的类型提示（Type Hints）进行数据验证、序列化和自动文档生成。

正是这种巧妙的结合，赋予了 FastAPI 无与伦比的优势。

FastAPI 的核心优势

1. 极致的性能

得益于 Starlette 和底层的 asyncio，FastAPI 是现今性能最强悍的 Python 框架之一，与 NodeJS 和 Go 的性能不相上下。对于需要处理高并发、I/O 密集型任务的现代 Web 应用而言，这意味着更低的延迟和更高的吞吐量。

2. 无与伦比的开发效率

这是 FastAPI 最吸引人的地方。

  • 基于类型提示：你只需要使用标准的 Python 类型提示（例如 str, int, bool 或更复杂的 Pydantic 模型）来声明函数参数和请求体，FastAPI 会自动处理一切。
  • 自动数据验证：如果传入的请求数据不符合你声明的类型，FastAPI 会自动返回一个清晰的 JSON 错误报告，告诉你哪个字段、因为什么原因出错。这极大地减少了开发者手动编写数据验证代码的工作量。
  • 自动交互式文档：FastAPI 会根据你的代码和类型提示，自动生成两种交互式的 API 文档（Swagger UI 和 ReDoc）。你不再需要手动维护 API 文档，文档永远与你的代码保持同步。开发者可以直接在浏览器中测试 API，这对于团队协作和前后端分离开发至关重要。

3. 现代化的异步支持

FastAPI 从一开始就基于 ASGI（Asynchronous Server Gateway Interface）标准构建。你可以轻松地使用 async 和 await 语法来编写异步代码，非常适合处理 WebSocket、长时间轮询、流式传输等需要长时间连接的 I/O 密集型任务。

4. 强大的依赖注入系统

FastAPI 内置了一个简单但功能强大的依赖注入系统。这使得代码的解耦和复用变得异常简单，同时也极大地提升了代码的可测试性。你可以轻松地注入数据库会话、用户认证依赖等。

实践：构建一个简单的待办事项（Todo）API

纸上谈兵终觉浅，让我们通过一个具体的例子来感受 FastAPI 的强大。我们将创建一个简单的待办事项 API，支持增删改查。

步骤 1: 环境准备

首先，安装 FastAPI 和一个 ASGI 服务器，如 Uvicorn。

bash
pip install fastapi "uvicorn[standard]" pydantic

步骤 2: 编写代码

创建一个名为 main.py 的文件，并写入以下代码：

“`python
from fastapi import FastAPI, HTTPException, Path
from pydantic import BaseModel
from typing import List, Dict

初始化 FastAPI 应用

app = FastAPI(
title=”我的待办事项 API”,
description=”一个使用 FastAPI 构建的简单待办事项 API。”,
version=”1.0.0″,
)

使用 Pydantic 定义数据模型

这个模型将用于请求体和响应体的数据验证与序列化

class Todo(BaseModel):
id: int
title: str
completed: bool = False

模拟一个简单的内存数据库

使用字典来存储待办事项，键是 ID，值是 Todo 对象

db: Dict[int, Todo] = {}

用于生成自增 ID

next_todo_id = 1

— API Endpoints —

@app.post(“/todos/”, response_model=Todo, status_code=201, summary=”创建一个新的待办事项”)
async def create_todo(todo_input: Todo):
“””
创建一个新的待办事项并将其存储在数据库中。
– id: 待办事项的唯一标识符。
– title: 待办事项的标题。
– completed: 待办事项是否完成的状态。
“””
global next_todo_id
# 确保传入的 ID 在数据库中尚不存在
if todo_input.id in db:
raise HTTPException(status_code=400, detail=f”Todo with ID {todo_input.id} already exists.”)

db[todo_input.id] = todo_input
# 更新下一个可用的 ID
if todo_input.id >= next_todo_id:
    next_todo_id = todo_input.id + 1

return todo_input

@app.get(“/todos/”, response_model=List[Todo], summary=”获取所有待办事项”)
async def get_all_todos():
“””
返回数据库中所有的待办事项列表。
“””
return list(db.values())

@app.get(“/todos/{todo_id}”, response_model=Todo, summary=”根据 ID 获取单个待办事项”)
async def get_todo_by_id(todo_id: int = Path(…, title=”待办事项的 ID”, ge=1)):
“””
根据提供的 ID 返回单个待办事项。
– todo_id: 必须是大于等于 1 的整数。
“””
if todo_id not in db:
raise HTTPException(status_code=404, detail=”Todo not found”)
return db[todo_id]

@app.put(“/todos/{todo_id}”, response_model=Todo, summary=”更新一个已存在的待办事项”)
async def update_todo(todo_input: Todo, todo_id: int = Path(…, title=”待办事项的 ID”, ge=1)):
“””
根据 ID 更新一个已存在的待办事项。
“””
if todo_id not in db:
raise HTTPException(status_code=404, detail=”Todo not found”)

db[todo_id] = todo_input
return db[todo_id]

@app.delete(“/todos/{todo_id}”, response_model=Dict[str, str], summary=”根据 ID 删除一个待办事项”)
async def delete_todo(todo_id: int = Path(…, title=”待办事项的 ID”, ge=1)):
“””
根据 ID 删除一个待办事项。
“””
if todo_id not in db:
raise HTTPException(status_code=404, detail=”Todo not found”)

del db[todo_id]
return {"message": "Todo deleted successfully"}

“`

步骤 3: 运行应用

在终端中，使用 Uvicorn 运行你的应用：

bash
uvicorn main:app --reload

--reload 参数会让服务器在代码变更后自动重启，非常适合开发阶段。

步骤 4: 探索自动生成的文档

现在，打开你的浏览器，访问 http://127.0.0.1:8000/docs。

你将看到由 Swagger UI 生成的交互式 API 文档。这里清晰地列出了我们所有的 API 端点、参数、请求体、响应模型和状态码。你甚至可以直接在这个页面上进行“Try it out”，发送真实的网络请求来测试你的 API！

FastAPI Swagger UI

你也可以访问 http://127.0.0.1:8000/redoc 来查看 ReDoc 生成的另一种风格的文档。

结论

通过这个简单的例子，我们可以清晰地看到 FastAPI 的设计哲学：用最少的代码，做最多的事，并把事情做到最好。

它将现代 Python 的特性（类型提示、异步）与 Web 开发的最佳实践（数据验证、自动文档、依赖注入）完美融合，极大地提升了开发体验和运行性能。它不仅是一个框架，更是一种全新的、更高效的 Web 开发范式。

如果你还在使用 Flask 或 Django，不妨花一点时间尝试一下 FastAPI。你很可能会发现，这正是你一直在寻找的，通往未来的 Web 开发之路。
“`

滚动至顶部