用途:为基于 FastAPI 与 SQLAlchemy 异步 ORM 的全栈项目提供从 API 设计到数据库实现的开发指引,适用于添加 API 端点与功能模块、创建或修改数据库模型与关系、编写 Repository 查询逻辑、实现 CRUD、编写测试、前后端集成与故障排查。
主要能力:API 端点开发(路由定义与注册、Pydantic 请求体与响应模型、Repository 依赖注入、错误处理);数据库模型设计(SQLAlchemy 2.0 异步 ORM、字段类型与约束、一对多/多对多关系、数据库迁移);Repository 模式(泛型 Repository、CRUD、复杂查询与过滤、事务与关系查询优化);异步测试(API、Repository、数据库 fixture 与集成测试);前端集成(静态文件挂载、CORS、API 代理、分离部署);故障排查(数据库连接与查询错误、API 错误、异步编程错误、性能与测试问题)。
使用方式:按场景分步进行。添加功能模块时依次完成需求理解、在 <project>/database/models.py 定义 ORM 模型、在 <project>/api/models.py 添加 Pydantic 模型、新建 <project>/api/v1/<module>.py 路由、在 routes.py 注册、编写 tests/test_<module>.py 并验证。常用命令:uvicorn <project>.app:app --reload;pytest -v;pytest tests/test_<module>.py -v;ruff check .;ruff format .;pyright。API 文档默认访问 http://localhost:8000/api/docs。资料还提供 assets/templates 下的应用入口、端点、模型、Pydantic、测试模板,以及 architecture.md、patterns.md、conventions.md、troubleshooting.md 参考文档,并建议开发前加载架构与规范、实现时查看模式、遇到问题查排查指南。
限制与注意:需替换模板中的占位符;生产环境修改模型要考虑数据迁移;密码使用 bcrypt,敏感信息从环境变量读取,输入用 Pydantic 验证,避免拼接 SQL。资料未提供具体版本号、安装命令、收费与授权信息。