引言
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API。它基于标准 Python 类型提示，旨在使异步 Web 开发既简单又强大。本文将深入解析 FastAPI，并通过实战示例展示如何高效开发。
FastAPI 简介
1. 特点
异步支持
：FastAPI 是异步的，这意味着它可以同时处理多个请求。
自动验证
：通过类型提示进行参数验证。
文档生成
：自动生成交互式 API 文档。
依赖注入
：内置依赖注入系统。
类型安全
：利用 Python 类型提示进行类型安全。
2. 快速开始
安装 FastAPI：
pip install fastapi uvicorn
创建一个基本的 FastAPI 应用：
from fastapi import FastAPI
app = FastAPI()
@app.get(“/”)
async def read_root():
return {“message”: “Hello, World!”}
运行应用：
uvicorn main:app –reload
访问
http://127.0.0.1:8000/
，将看到 “Hello, World!” 消息。
实战示例
1. 路径参数
路径参数允许您通过 URL 传递参数。
from fastapi import FastAPI, Path
app = FastAPI()
@app.get(“/items/{item_id}”)
async def read_item(item_id: int = Path(…, title=”The id of the item to get”)):
return {“item_id”: item_id}
2. 查询参数
查询参数允许您通过 URL 查询字符串传递参数。
from fastapi import FastAPI, Query
app = FastAPI()
@app.get(“/items/”)
async def read_items(q: str = Query(…, title=”Query string”)):
if q:
return {“q”: q}
return {“items”: [{“item_id”: 1, “name”: “Item1”}, {“item_id”: 2, “name”: “Item2″}]}
3. 身份验证
FastAPI 支持多种身份验证方法。
from fastapi import FastAPI, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer
app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl=”token”)
def get_current_user(token: str = Depends(oauth2_scheme)):
# 伪代码：验证 token
if not token:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=”Could not validate credentials”,
headers={“WWW-Authenticate”: “Bearer”},
)
return {“token”: token}
@app.post(“/token”)
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
user = authenticate_user(fake_db, form_data.username, form_data.password)
if not user:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=”Incorrect username or password”,
headers={“WWW-Authenticate”: “Bearer”},
)
access_token = create_access_token(data={“sub”: user.username})
return {“access_token”: access_token, “token_type”: “bearer”}
4. 依赖注入
依赖注入是 FastAPI 的一个强大功能，它允许您将依赖项注入到您的处理函数中。
from fastapi import FastAPI, Depends, HTTPException, status
app = FastAPI()
def get_user(user_id: int = Depends(get_current_user)):
# 伪代码：根据用户 ID 获取用户
return {“user_id”: user_id}
@app.get(“/users/me”)
async def read_users_me(current_user: dict = Depends(get_current_user)):
return current_user
5. 数据模型
FastAPI 支持数据模型，允许您在代码中定义数据结构。
from pydantic import BaseModel
class Item(BaseModel):
id: int
name: str
@app.post(“/items/”)
async def create_item(item: Item):
return item
6. 交互式文档
FastAPI 自动生成交互式文档，您可以通过访问
/docs
或
/redoc
来查看。
总结
FastAPI 是一个功能强大的 Web 框架，适合构建高性能、类型安全的 API。通过本文的实战示例，您应该已经了解了如何使用 FastAPI 进行高效开发。希望这篇文章能够帮助您更好地掌握 FastAPI。