Python FastAPI：快速搭建高效RESTful API的50个实用技巧

1. 使用Pydantic模型验证数据

Pydantic是FastAPI中用于数据验证和验证的工具，它可以帮助你确保传入的数据符合你的预期。

from pydantic import BaseModel

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

2. 利用依赖注入系统

FastAPI的依赖注入系统非常强大，你可以轻松地注入数据库模型、服务或其他依赖。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session

app = FastAPI()

# 定义依赖项
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

3. 实现异步功能

FastAPI支持异步处理，这意味着你可以编写异步的视图函数。

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int, db: Session = Depends(get_db)):
    item = db.query(Item).filter(Item.id == item_id).first()
    if not item:
        raise HTTPException(status_code=404, detail="Item not found")
    return item

4. 使用参数验证

FastAPI允许你为参数添加验证规则，确保它们是有效的。

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/items/")
async def read_items(q: str = Query(None, min_length=1)):
    if q:
        items = db.query(Item).filter(Item.name.contains(q)).all()
        return items
    return []

5. 创建用户友好的错误响应

你可以自定义错误响应，使它们更易于理解。

from fastapi.responses import JSONResponse

@app.exception_handler(Exception)
async def custom_exception_handler(request, exc):
    return JSONResponse(
        status_code=500,
        content={"message": f"An error occurred: {exc}"}
    )

6. 使用中间件

中间件允许你在请求的生命周期中添加额外的逻辑。

from fastapi import FastAPI, Request

app = FastAPI()

@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    start_time = time.time()
    response = await call_next(request)
    process_time = time.time() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    return response

7. 利用OAuth2密码授权

FastAPI支持OAuth2密码授权，你可以轻松地实现用户认证。

from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="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_code.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"}

8. 集成Redis

Redis是一个高性能的键值存储系统，可以用于缓存和会话管理等。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer
from passlib.context import CryptContext
from pydantic import BaseModel
from sqlalchemy.orm import Session
from typing import Optional
import redis

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
bcrypt = CryptContext(schemes=["bcrypt"], deprecated="auto")
redis_client = redis.StrictRedis(host="localhost", port=6379, db=0)

class User(BaseModel):
    username: str
    hashed_password: str

fake_db = {"test": {"username": "test", "hashed_password": "hashed_test"}}

def authenticate_user(db, username: str, password: str):
    user = db.get(username)
    if not user or not bcrypt.verify(password, user["hashed_password"]):
        return False
    return user

def create_access_token(data: dict):
    return jwt.encode(data, SECRET_KEY, algorithm="HS256")

@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_code.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"}

9. 使用Multipart/URL-encoded Form

FastAPI支持Multipart/URL-encoded Form，这对于上传文件等操作非常有用。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

10. 实现跨域资源共享（CORS）

CORS允许你控制哪些网站可以访问你的API。

from fastapi import FastAPI, Request

app = FastAPI()

@app.middleware("http")
async def cors_middleware(request: Request, call_next):
    response = await call_next(request)
    response.headers["Access-Control-Allow-Origin"] = "*"
    response.headers["Access-Control-Allow-Methods"] = "POST, GET, OPTIONS"
    response.headers["Access-Control-Allow-Headers"] = "Content-Type, Authorization"
    return response

11. 使用环境变量

使用环境变量可以帮助你更好地管理配置。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    item_name = os.getenv("ITEM_NAME", "default_item")
    return {"item_name": item_name}

12. 利用SQLAlchemy ORM

SQLAlchemy是一个强大的ORM，可以用于数据库操作。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

13. 实现分页

分页可以帮助你处理大量数据。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(page: int = 1, limit: int = 10, db: Session = Depends(get_db)):
    items = db.query(Item).paginate(page=page, limit=limit)
    return items.items

14. 使用FastAPI的JSON响应

FastAPI可以自动将Python对象序列化为JSON格式。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}]

15. 实现文件上传

FastAPI支持文件上传，你可以轻松地处理文件上传请求。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

16. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

17. 实现OAuth2密码授权

OAuth2密码授权可以帮助你实现用户认证。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from models import User

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status_code.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"}

18. 利用JSON Schema生成交互式API文档

FastAPI可以自动生成交互式API文档，方便开发者使用。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}]

19. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

20. 实现文件下载

FastAPI支持文件下载，你可以轻松地处理文件下载请求。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

21. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

22. 实现OAuth2密码授权

OAuth2密码授权可以帮助你实现用户认证。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from models import User

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status_code.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"}

23. 利用JSON Schema生成交互式API文档

FastAPI可以自动生成交互式API文档，方便开发者使用。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}]

24. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

25. 实现文件下载

FastAPI支持文件下载，你可以轻松地处理文件下载请求。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

26. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

27. 实现OAuth2密码授权

OAuth2密码授权可以帮助你实现用户认证。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from models import User

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status_code.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"}

28. 利用JSON Schema生成交互式API文档

FastAPI可以自动生成交互式API文档，方便开发者使用。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}]

29. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

30. 实现文件下载

FastAPI支持文件下载，你可以轻松地处理文件下载请求。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

31. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

32. 实现OAuth2密码授权

OAuth2密码授权可以帮助你实现用户认证。

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from models import User

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status_code.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"}

33. 利用JSON Schema生成交互式API文档

FastAPI可以自动生成交互式API文档，方便开发者使用。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}]

34. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from typing import Optional
from models import Base, Item

app = FastAPI()

# 创建数据库会话
def get_db():
    db = Session()
    try:
        yield db
    finally:
        db.close()

@app.get("/items/")
async def read_items(db: Session = Depends(get_db)):
    items = db.query(Item).all()
    return items

35. 实现文件下载

FastAPI支持文件下载，你可以轻松地处理文件下载请求。

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

36. 使用FastAPI的依赖注入系统

依赖注入系统可以帮助你管理依赖关系。

”`python from fastapi import FastAPI, Depends, HTTPException from sqlalchemy.orm import Session from

1. 使用Pydantic模型验证数据

2. 利用依赖注入系统

3. 实现异步功能

4. 使用参数验证

5. 创建用户友好的错误响应

6. 使用中间件

7. 利用OAuth2密码授权

8. 集成Redis

9. 使用Multipart/URL-encoded Form

10. 实现跨域资源共享（CORS）

11. 使用环境变量

12. 利用SQLAlchemy ORM

13. 实现分页

14. 使用FastAPI的JSON响应

15. 实现文件上传

16. 使用FastAPI的依赖注入系统

17. 实现OAuth2密码授权

18. 利用JSON Schema生成交互式API文档

19. 使用FastAPI的依赖注入系统

20. 实现文件下载

21. 使用FastAPI的依赖注入系统

22. 实现OAuth2密码授权

23. 利用JSON Schema生成交互式API文档

24. 使用FastAPI的依赖注入系统

25. 实现文件下载

26. 使用FastAPI的依赖注入系统

27. 实现OAuth2密码授权

28. 利用JSON Schema生成交互式API文档

29. 使用FastAPI的依赖注入系统

30. 实现文件下载

31. 使用FastAPI的依赖注入系统

32. 实现OAuth2密码授权

33. 利用JSON Schema生成交互式API文档

34. 使用FastAPI的依赖注入系统

35. 实现文件下载

36. 使用FastAPI的依赖注入系统

相关阅读

如何轻松配置容器端口，实现高效网络通信？

高效项目管理，迭代周期优化策略大揭秘：从实际案例看最佳实践全解析

揭秘面向对象设计原则：如何打造高效、可维护的软件系统

掌握Solus OS开发秘诀：五大实战技巧助你高效构建个性化系统

掌握Git中行尾换行符的正确配置，告别跨平台编码困扰

如何轻松关闭Linux文件：避免数据丢失的5个实用技巧

学会MongoDB：高效数据模型设计秘籍，实战案例分析让你轻松驾驭！

如何轻松提高Web表单数据验证效率：实战技巧与最佳案例解析

提升SQL查询效率的7大实战技巧揭秘：告别慢查询，让你的数据库如虎添翼

学会编制总账报表，企业财务管理的秘密武器