fastapi-best-practices

FastAPI 中文最佳实践

项目结构

├── app/
│   ├── __init__.py
│   ├── main.py           # 入口文件
│   ├── config.py          # 配置
│   ├── database.py        # 数据库连接
│   ├── models/            # 数据模型
│   │   ├── user.py
│   │   └── order.py
│   ├── schemas/           # Pydantic模型
│   │   ├── user.py
│   │   └── order.py
│   ├── api/               # API路由
│   │   ├── v1/
│   │   │   ├── user.py
│   │   │   └── order.py
│   │   └── deps.py        # 依赖注入
│   ├── services/          # 业务逻辑
│   │   └── user.py
│   └── utils/             # 工具函数
│       └── security.py
├── tests/
├── alembic/               # 数据库迁移
├── requirements.txt
└── .env

路由模板

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session
from app.api.deps import get_db, get_current_user
from app.schemas.user import UserCreate, UserResponse
from app.services.user import UserService

router = APIRouter(prefix="/users", tags=["用户"])

@router.post("/", response_model=UserResponse, summary="创建用户")
async def create_user(
    user_in: UserCreate,
    db: Session = Depends(get_db)
):
    """
    创建新用户
    
    - **username**: 用户名，3-20个字符
    - **password**: 密码，至少8位
    - **phone**: 手机号，11位数字
    """
    service = UserService(db)
    user = await service.create(user_in)
    return user

@router.get("/{user_id}", response_model=UserResponse, summary="获取用户信息")
async def get_user(
    user_id: int,
    db: Session = Depends(get_db),
    current_user = Depends(get_current_user)
):
    """根据用户ID获取用户信息"""
    service = UserService(db)
    user = await service.get_by_id(user_id)
    if not user:
        raise HTTPException(status_code=404, detail="用户不存在")
    return user

错误处理

from fastapi import HTTPException
from fastapi.responses import JSONResponse

class AppException(Exception):
    def __init__(self, code: int, message: str):
        self.code = code
        self.message = message

@app.exception_handler(AppException)
async def app_exception_handler(request, exc):
    return JSONResponse(
        status_code=200,
        content={"code": exc.code, "message": exc.message, "data": None}
    )

# 使用
raise AppException(code=1001, message="用户名已存在")