如何使用 FastAPI 框架创建 RESTful API ？

FastAPI是一个现代、快速（高性能）的Web框架，用于构建API，它基于Python 3.6+的类型提示功能，可以自动生成交互式API文档（使用Swagger UI或ReDoc），并且支持异步编程。

二、创建第一个FastAPI应用

首先，确保你已经安装了FastAPI和Uvicorn（一个ASGI服务器）。你可以使用pip来安装它们：

pip install fastapi uvicorn

接下来，创建一个简单的FastAPI应用：

from fastapi import FastAPI

app = FastAPI()

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

# 运行应用
# 在命令行中执行以下命令：
# uvicorn main:app --reload

在这个例子中，我们创建了一个FastAPI实例app，并定义了一个GET请求的路由/，当访问这个路由时，会返回一个JSON响应。

三、定义数据模型

在实际开发中，我们经常需要处理复杂的数据结构。FastAPI支持使用Pydantic来定义数据模型，这样可以方便地进行数据验证和序列化。

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

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

在这个例子中，我们定义了一个Item数据模型，并在/items/路由中使用它来接收POST请求的数据。

四、处理路径参数和查询参数

FastAPI允许你轻松地处理路径参数和查询参数。

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

在这个例子中，{item_id}是一个路径参数，q是一个可选的查询参数。

五、实际开发建议

1. 使用异步编程：FastAPI支持异步编程，这可以提高应用的性能和响应能力。在处理I/O密集型任务时，尽量使用异步方法。
2. 合理使用依赖注入：FastAPI支持依赖注入，这可以帮助你更好地组织代码和提高代码的可重用性。例如，你可以将数据库连接或身份验证逻辑作为依赖项注入到路由处理函数中。
3. 利用Pydantic进行数据验证：Pydantic提供了强大的数据验证功能，确保接收到的数据符合预期的格式和类型。这可以减少因数据问题导致的错误和安全漏洞。
4. 编写详细的API文档：FastAPI可以自动生成交互式API文档，这对于团队协作和API的维护非常有帮助。确保你的API文档清晰、详细，并及时更新。

六、实际开发注意事项

1. 性能优化：虽然FastAPI本身已经非常高效，但在处理大量请求或复杂计算时，仍需注意性能优化。例如，可以使用缓存来减少数据库查询次数，或者使用异步任务队列来处理耗时的任务。
2. 安全性考虑：在设计API时，需要考虑安全性问题。例如，对敏感数据进行加密传输，实施身份验证和授权机制，以及防止常见的Web攻击（如SQL注入、跨站脚本攻击等）。
3. 版本控制：随着项目的迭代和发展，API可能会发生变化。为了确保向后兼容性，建议对API进行版本控制。你可以在URL中包含版本号，或者使用HTTP头部来指定版本。
4. 错误处理：设计良好的错误处理机制对于提高用户体验和便于调试非常重要。FastAPI允许你自定义异常处理器，以便在发生错误时返回统一的响应格式。
5. 测试：编写单元测试和集成测试是确保API稳定性和可靠性的关键步骤。FastAPI提供了方便的测试工具，你可以使用它来编写和运行测试用例。

七、代码示例：完整的FastAPI应用

下面是一个更完整的FastAPI应用示例，包括数据模型、路由处理、依赖注入和错误处理：

from fastapi import FastAPI, Depends, HTTPException
from pydantic import BaseModel
from typing import List

app = FastAPI()

# 数据模型
class Item(BaseModel):
    name: str
    price: float

class ItemList(BaseModel):
    items: List[Item]

# 模拟数据库
fake_db = {}

# 依赖项：获取所有项目
def get_all_items() -> List[Item]:
    return list(fake_db.values())

# 路由：获取所有项目
@app.get("/items/", response_model=ItemList)
async def read_items(items: List[Item] = Depends(get_all_items)):
    return {"items": items}

# 路由：创建新项目
@app.post("/items/", response_model=Item)
async def create_item(item: Item):
    if item.name in fake_db:
        raise HTTPException(status_code=400, detail="Item already exists")
    fake_db[item.name] = item.dict()
    return item

# 路由：获取单个项目
@app.get("/items/{item_name}", response_model=Item)
async def read_item(item_name: str):
    item = fake_db.get(item_name)
    if not item:
        raise HTTPException(status_code=404, detail="Item not found")
    return Item(**item)

在这个示例中，我们创建了一个简单的“项目”管理API，包括获取所有项目、创建新项目和获取单个项目的功能。

我们还使用了依赖注入来获取所有项目，并添加了基本的错误处理逻辑。