FastAPI 项目中合理的文件结构

1. 项目结构示例

my_fastapi_project/
├── app/
│   ├── __init__.py
│   ├── main.py               # 应用入口
│   ├── core/                 # 核心配置和工具
│   │   ├── __init__.py
│   │   ├── config.py         # 配置文件
│   │   ├── security.py       # 认证和授权逻辑
│   │   └── utils.py          # 工具函数
│   ├── models/               # 数据库模型
│   │   ├── __init__.py
│   │   ├── user.py           # 用户模型
│   │   └── item.py           # 商品模型
│   ├── schemas/              # Pydantic 模型
│   │   ├── __init__.py
│   │   ├── user.py           # 用户相关模型
│   │   └── item.py           # 商品相关模型
│   ├── api/                  # API 路由
│   │   ├── __init__.py
│   │   ├── v1/               # 版本化 API
│   │   │   ├── __init__.py
│   │   │   ├── users.py      # 用户相关路由
│   │   │   └── items.py      # 商品相关路由
│   │   └── health_check.py   # 健康检查路由
│   ├── crud/                 # 数据库操作
│   │   ├── __init__.py
│   │   ├── user.py           # 用户相关操作
│   │   └── item.py           # 商品相关操作
│   ├── dependencies.py       # 依赖注入
│   ├── database.py           # 数据库连接
│   └── exceptions.py         # 自定义异常
├── tests/                    # 测试代码
│   ├── __init__.py
│   ├── test_users.py         # 用户相关测试
│   └── test_items.py         # 商品相关测试
├── requirements.txt          # 依赖文件
├── Dockerfile                # Docker 配置
└── README.md                 # 项目说明

2. 文件命名规范

核心文件

核心模块 (core/)

模型模块 (models/)

Pydantic 模型 (schemas/)

API 路由 (api/)

CRUD 操作 (crud/)

测试模块 (tests/)

3. 命名建议

4. 示例代码

app/main.py

from fastapi import FastAPI
from app.api.v1 import users, items

app = FastAPI()

app.include_router(users.router)
app.include_router(items.router)

app/api/v1/users.py

from fastapi import APIRouter, Depends
from app.schemas.user import UserCreate, UserResponse
from app.crud.user import create_user
from app.database import get_db

router = APIRouter()

@router.post("/users/", response_model=UserResponse)
def create_new_user(user: UserCreate, db=Depends(get_db)):
    return create_user(db, user)

app/schemas/user.py

from pydantic import BaseModel

class UserCreate(BaseModel):
    username: str
    email: str
    password: str

class UserResponse(BaseModel):
    id: int
    username: str
    email: str

app/crud/user.py

from app.models.user import User
from app.schemas.user import UserCreate

def create_user(db, user: UserCreate):
    db_user = User(username=user.username, email=user.email, password=user.password)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user

app/models/user.py

from sqlalchemy import Column, Integer, String
from app.database import Base

class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True, index=True)
    username = Column(String, unique=True)
    email = Column(String, unique=True)
    password = Column(String)

5. 总结