简介

FastAPI 是一个基于 Python 的现代、快速（高性能）的 Web 框架，用于构建 API。它使用类型提示来提高代码的可读性和可维护性，同时利用异步编程来实现高性能。FastAPI 基于 Python 的 pydantic 库进行数据验证和解析，基于 uvicorn 等 ASGI 服务器运行，能极大地提升开发效率和应用性能。

目录

  1. 基础概念
  2. 使用方法
  3. 常见实践
  4. 最佳实践
  5. 小结
  6. 参考资料

基础概念

ASGI

FastAPI 遵循 ASGI（Asynchronous Server Gateway Interface）规范。ASGI 是一种异步的服务器网关接口，它允许 Python Web 框架和应用与服务器进行异步通信，从而实现高性能的异步编程。与传统的 WSGI（Web Server Gateway Interface）相比，ASGI 更好地支持异步 I/O 操作，如异步数据库查询、文件读取等。

Pydantic

Pydantic 是 FastAPI 用于数据验证和解析的库。它使用类型提示来定义数据模型，并能自动验证传入的数据是否符合这些模型。例如，你可以定义一个用户数据模型：

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    age: int

这个模型定义了一个用户应该包含的字段及其类型。Pydantic 会在数据传入时自动验证其是否符合这个模型。

使用方法

安装

首先，你需要安装 FastAPI 和一个 ASGI 服务器，如 uvicorn：

pip install fastapi uvicorn

基本示例

下面是一个简单的 FastAPI 应用示例：

from fastapi import FastAPI

app = FastAPI()

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

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

在这个示例中：

  • 我们创建了一个 FastAPI 实例 app。
  • 使用 @app.get 装饰器定义了两个 API 端点。
    • 第一个端点 "/" 返回一个简单的 JSON 消息。
    • 第二个端点 "/items/{item_id}" 接受一个路径参数 item_id 和一个可选的查询参数 q，并返回包含这两个参数的 JSON 数据。

运行应用

使用 uvicorn 运行这个应用：

uvicorn main:app --reload

这里 main 是 Python 文件名（如果你的代码保存在 main.py 中），app 是 FastAPI 实例。--reload 选项让服务器在代码发生变化时自动重新加载，方便开发。

常见实践

请求体处理

在 FastAPI 中处理请求体非常简单。例如，接收一个 JSON 格式的用户数据：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    email: str
    age: int

@app.post("/users/")
def create_user(user: User):
    return user

在这个示例中，User 是一个 Pydantic 模型，作为 create_user 函数的参数。FastAPI 会自动解析请求体并验证其是否符合 User 模型。

响应处理

你可以自定义响应的状态码、头部等信息。例如：

from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/custom_response/")
def custom_response():
    content = {"message": "Custom Response"}
    headers = {"X-Custom-Header": "Value"}
    return Response(content=content, headers=headers, status_code=201)

这个端点返回一个带有自定义头部和状态码 201 Created 的响应。

依赖注入

FastAPI 支持依赖注入，这在处理数据库连接、认证等功能时非常有用。例如：

from fastapi import Depends, FastAPI

app = FastAPI()

def get_token_header(x_token: str = Depends()):
    if x_token != "fake-super-secret-token":
        raise HTTPException(status_code=400, detail="X-Token header invalid")
    return x_token

@app.get("/protected/")
def protected_route(token: str = Depends(get_token_header)):
    return {"message": "This is a protected route"}

在这个示例中，get_token_header 函数作为依赖项，protected_route 端点在调用时会先验证 X-Token 头部是否正确。

最佳实践

项目结构

建议按照以下结构组织项目：

project/
    ├── app/
    │   ├── __init__.py
    │   ├── main.py
    │   ├── routers/
    │   │   ├── __init__.py
    │   │   ├── users.py
    │   │   └── items.py
    │   ├── models/
    │   │   ├── __init__.py
    │   │   └── user.py
    │   └── dependencies/
    │       ├── __init__.py
    │       └── database.py
    ├── tests/
    │   ├── __init__.py
    │   └── test_main.py
    └── requirements.txt
  • main.py 是应用的入口点。
  • routers 目录存放各个模块的路由定义。
  • models 目录包含 Pydantic 模型。
  • dependencies 目录存放依赖项相关代码。
  • tests 目录用于编写测试用例。

错误处理

使用全局异常处理来处理应用中的各种异常。例如：

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse

app = FastAPI()

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

这样，当应用中抛出 HTTPException 时，会统一按照这个处理函数返回 JSON 格式的错误信息。

性能优化

  • 使用异步函数：尽量将 I/O 操作（如数据库查询、文件读取）写成异步函数，充分利用 ASGI 的异步特性。
  • 缓存：对于频繁访问的数据，可以使用缓存机制（如 redis）来减少数据库查询次数。

小结

FastAPI 是一个功能强大、易于使用的 Python Web 框架，适合构建高性能的 API。通过了解其基础概念、掌握使用方法、熟悉常见实践和遵循最佳实践，开发者可以高效地开发出健壮、可维护且高性能的 Web 应用。无论是小型项目还是大型企业级应用，FastAPI 都能发挥其优势。

参考资料