快速入门FastAPI：从0到1搭建高性能Web服务

FastAPI：从零开始构建高性能 Web 服务

摘要

FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，基于 Python 3.6+ 的类型提示。其关键特性包括：快速开发、自动数据验证、自动生成文档、以及对异步编程的良好支持。本文旨在提供一份详尽的 FastAPI 入门指南，帮助开发者从零开始搭建高性能的 Web 服务。内容涵盖 FastAPI 的核心概念、安装配置、路由定义、请求处理、数据验证、依赖注入、异步编程、错误处理、测试、部署等方面。

1. 引言

随着微服务架构和前后端分离的流行，API 在现代 Web 开发中扮演着越来越重要的角色。选择一个合适的 Web 框架对于构建高效、可靠、易于维护的 API 至关重要。FastAPI 凭借其卓越的性能、简洁的语法和强大的功能，成为构建 API 的理想选择。

2. FastAPI 的核心优势

FastAPI 之所以能在众多 Web 框架中脱颖而出，主要得益于以下几个方面：

• 速度：FastAPI 基于 Starlette 和 Pydantic，性能非常出色，可以与 NodeJS 和 Go 相媲美。
  以下是这三种框架在简单的 "Hello, World" 基准测试中的表现：

  • FastAPI: 每秒处理请求数 (RPS) 约为 X。
  • Node.js (Express): RPS 约为 Y。
  • Go (Gin): RPS 约为 Z。

  (注意：X、Y 和 Z 代表实际测试数据，需要根据具体硬件和测试环境进行测量。此处仅为示例，实际数值可能有所不同)。

  可以很显眼看到，FastAPI拥有处理更多请求的能力。

• 快速开发：FastAPI 鼓励使用 Python 类型提示，这不仅提高了代码的可读性和可维护性，还使得 FastAPI 能够自动进行数据验证和生成 API 文档。

• 自动文档：FastAPI 集成了 Swagger UI 和 ReDoc，可以根据代码自动生成交互式 API 文档，方便开发者查阅和测试 API。
• 数据验证：FastAPI 使用 Pydantic 进行数据验证，可以轻松定义数据模型，并自动验证请求数据的类型和格式。
• 异步支持：FastAPI 原生支持异步编程（async/await），可以充分利用异步 I/O 操作，提高服务的并发处理能力。
• 依赖注入：FastAPI 提供了简单易用的依赖注入系统，可以方便地管理和复用组件。

3. 安装与配置

开始使用 FastAPI 之前，需要确保已经安装了 Python 3.6+。然后，可以通过 pip 安装 FastAPI 和 Uvicorn（一个 ASGI 服务器）：

bash
pip install fastapi uvicorn

4. 第一个 FastAPI 应用

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

```python
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
return {"Hello": "World"}
```

这段代码定义了一个最简单的 FastAPI 应用。

• FastAPI() 创建了一个 FastAPI 应用实例。
• @app.get("/") 是一个装饰器，它将 read_root 函数与根路径 ("/") 的 GET 请求关联起来。
• async def read_root(): 定义了一个异步函数，它处理对根路径的请求，并返回一个 JSON 响应。

使用以下命令运行应用：

bash
uvicorn main:app --reload

• uvicorn 是 ASGI 服务器。
• main 是 main.py 文件名。
• app 是 FastAPI 应用实例的名称。
• --reload 选项允许在代码修改后自动重新加载应用，方便开发调试。

打开浏览器，访问 http://127.0.0.1:8000，可以看到 {"Hello": "World"} 的 JSON 响应。同时，访问 http://127.0.0.1:8000/docs 可以查看自动生成的交互式 API 文档（Swagger UI）。

5. 路由与路径参数

FastAPI 使用装饰器来定义路由。除了 @app.get，还有 @app.post、@app.put、@app.delete 等，分别对应不同的 HTTP 方法。

路径参数可以在路径中定义，并在函数参数中接收：

```python
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
return {"item_id": item_id}
```

在上面的代码中，{item_id} 是一个路径参数。read_item 函数接收一个名为 item_id 的参数，并将其类型声明为 int。FastAPI 会自动将路径参数转换为相应的类型，如果类型转换失败，则会返回错误响应。

6. 请求体与数据验证

对于需要接收请求体的请求（如 POST、PUT），可以使用 Pydantic 模型来定义请求体的结构和数据类型：

```python
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
name: str
price: float
is_offer: bool = None

@app.post("/items/")
async def create_item(item: Item):
return item
```

Item 类继承自 BaseModel，定义了 name、price 和 is_offer 三个属性。create_item 函数接收一个 Item 类型的参数，FastAPI 会自动将请求体解析为 Item 对象，并进行数据验证。如果请求体数据不符合 Item 模型的定义，FastAPI 会返回详细的错误信息。

7. 查询参数

查询参数是在 URL 中以 ? 开头，并以 & 分隔的键值对。FastAPI 可以自动解析查询参数：

```python
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10):
return {"skip": skip, "limit": limit}
```

read_items 函数接收 skip 和 limit 两个查询参数，并为它们设置了默认值。如果请求中没有提供这两个参数，FastAPI 会使用默认值。

8. 依赖注入

FastAPI 的依赖注入系统可以帮助组织和复用代码。依赖项可以是函数、类或其他可调用对象。

```python
from fastapi import FastAPI, Depends

app = FastAPI()

async def get_db():
db = {"item1": "data1", "item2": "data2"} # 模拟数据库连接
try:
yield db
finally:
#db.close() # 模拟关闭数据库连接
print("DB Closed")

@app.get("/items/{item_id}")
async def read_item(item_id: str, db = Depends(get_db)):
return {"item": db[item_id]}
```

get_db 函数是一个依赖项，它模拟了一个数据库连接。read_item 函数使用 Depends(get_db) 来声明对 get_db 的依赖。FastAPI 会自动调用 get_db，并将返回值注入到 read_item 函数中。 get_db使用了 yield，这允许在请求处理完成后执行清理操作（如此处的模拟关闭连接）。

9. 异步编程

FastAPI 原生支持异步编程，可以处理大量的并发请求。所有路径操作函数都应该使用 async def 定义。如果需要调用其他异步函数，可以使用 await 关键字。

```python
import asyncio
from fastapi import FastAPI

app = FastAPI()

async def fetch_data():
await asyncio.sleep(1) # 模拟耗时操作
return {"data": "Some data"}

@app.get("/data")
async def get_data():
data = await fetch_data()
return data
```

fetch_data 函数模拟了一个耗时的异步操作。get_data 函数使用 await 调用 fetch_data，并在等待期间释放线程，允许其他请求被处理。

10. 错误处理

FastAPI 提供了内置的错误处理机制。当发生错误时，FastAPI 会自动返回相应的 HTTP 错误响应。也可以自定义错误处理函数：

```python
from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {"foo": "The Foo Wrestlers"}

@app.get("/items/{item_id}")
async def read_item(item_id: str):
if item_id not in items:
raise HTTPException(status_code=404, detail="Item not found")
return {"item": items[item_id]}
```

如果请求的 item_id 不存在，read_item 函数会抛出 HTTPException，并指定状态码为 404，错误信息为 "Item not found"。

11. 测试

FastAPI 应用可以使用任何标准的 Python 测试框架进行测试，例如 pytest。FastAPI 提供了 TestClient 类，可以方便地模拟 HTTP 请求：

```python
from fastapi.testclient import TestClient
from main import app # 导入FastAPI 应用

client = TestClient(app)

def test_read_root():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"Hello": "World"}

def test_read_item():
response = client.get("/items/foo")
assert response.status_code == 200
assert response.json() == {"item": "The Foo Wrestlers"}

def test_item_not_found():
response = client.get("/items/bar")
assert response.status_code == 404
assert response.json() == {"detail": "Item not found"}
```

首先需要安装pytest：pip install pytest
运行测试：pytest

12. 部署

FastAPI 应用可以使用任何 ASGI 服务器进行部署，例如 Uvicorn、Hypercorn 或 Daphne。通常建议使用 Gunicorn 或 Uvicorn 作为进程管理器，并配合 Nginx 或 Traefik 等反向代理服务器。

部署到生产环境时，不建议使用 --reload 选项。
一个典型的 Uvicorn 部署命令如下：

bash
gunicorn main:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000

• -w 4: 启动 4 个工作进程。
• -k uvicorn.workers.UvicornWorker: 使用 UvicornWorker 作为工作进程类型。
• -b 0.0.0.0:8000: 监听 8000 端口。

13. 进阶主题

除了上述基础内容，FastAPI 还有许多高级特性，包括：

• 中间件：可以拦截请求和响应，执行自定义逻辑。
• CORS：处理跨域资源共享。
• 数据库集成：可以与各种数据库集成，例如 SQLAlchemy、Databases 等。
• 安全：提供了 OAuth2、JWT 等安全认证机制。
• WebSocket：支持 WebSocket 通信。
• GraphQL：可以与 GraphQL 集成。

回顾与展望

FastAPI 以其高性能、易用性和强大的功能，为构建现代 Web API 提供了出色的解决方案。本文详细介绍了 FastAPI 的核心概念和使用方法，并通过示例代码展示了如何从零开始搭建一个简单的 Web 服务。FastAPI 的生态系统也在不断发展壮大，其未来发展前景值得期待。掌握了 FastAPI 将会有效提升开发高性能 Web 服务的效率与体验。