FastAPI快速入门

1. 快速入门

以下是一个简单的 FastAPI 应用示例，展示了如何创建和运行一个基本的 Web 应用。

1.1 安装 FastAPI 和 Uvicorn

使用 pip 安装 FastAPI 和 Uvicorn（ASGI 服务器）：

pip install fastapi uvicorn

1.2 创建一个简单的 FastAPI 应用

创建一个名为 main.py 的文件，内容如下：

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}

1.3 运行 FastAPI 应用

在命令行中运行以下命令启动 Uvicorn 服务器：

uvicorn main:app --reload

访问 http://127.0.0.1:8000/，你将看到返回的 JSON 响应 {"Hello": "World"}。

访问 http://127.0.0.1:8000/items/1?q=test，你将看到返回的 JSON 响应 {"item_id": 1, "q": "test"}。

1.4 自动生成的文档

访问 http://127.0.0.1:8000/docs，查看自动生成的 Swagger UI 文档。

访问 http://127.0.0.1:8000/redoc，查看自动生成的 ReDoc 文档。

2. 数据模型和验证示例

使用 Pydantic 定义数据模型和验证。

创建一个名为 main.py 的文件，内容如下：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

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

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

运行应用并发送 POST 请求到 /items/ 端点，可以验证和处理请求体中的数据。

3. 路由和依赖注入示例

from fastapi import Depends, FastAPI

app = FastAPI()

def get_query_token(token: str):
    if token != "jessica":
        raise HTTPException(status_code=400, detail="Invalid token")
    return token

@app.get("/items/")
def read_items(token: str = Depends(get_query_token)):
    return [{"item": "Foo"}, {"item": "Bar"}]

4. 异步支持示例

import asyncio
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    await asyncio.sleep(1)
    return {"message": "Hello World"}

5. 总结

FastAPI 是一个现代、高性能的 Web 框架，非常适合构建快速、可靠和可扩展的 API。它利用 Python 的类型提示实现了自动文档生成、数据验证和类型安全，极大地提高了开发效率和代码质量。无论是简单的 API 服务还是复杂的 Web 应用，FastAPI 都提供了强大的功能和灵活性，使其成为开发者的理想选择。