FastAPI 开发模式助手

这个技能能帮你做什么

如果你在用 Python 的 FastAPI 框架开发 API 服务，这个技能能帮你写出更规范、更可靠的代码。它不是教你 Python 语法或 FastAPI 基础，而是告诉你生产环境中应该怎么组织项目、怎么处理常见问题。

简单说，它能帮你：

• 搭建项目 —— 合理的目录结构和模块划分，让项目从一开始就有序
• 定义接口 —— 用数据模型规范请求和响应，自动校验参数
• 处理认证 —— 用户登录、权限验证、Token 管理的安全实现
• 管理依赖 —— 数据库连接、用户对象等依赖的注入和生命周期管理
• 组织业务逻辑 —— 把业务逻辑从路由层抽离，代码更清晰
• 测试接口 —— 为 API 写自动化测试，确保功能稳定

什么时候用

新项目启动时 —— 先确定项目结构和技术方案，再开始开发

写新接口时 —— 不确定接口怎么设计最规范？它会给你最佳实践

处理用户认证时 —— 登录、注册、Token 验证等安全相关功能

数据库操作时 —— 连接管理、事务处理、并发安全等

审查代码时 —— 检查代码是否符合 FastAPI 社区推荐的做法

主要覆盖哪些场景

1. 项目结构
   • 合理的目录组织，分离路由、模型、业务逻辑
   • 配置管理，不同环境（开发、测试、生产）的配置切换
   • 应用工厂模式，灵活创建和配置应用实例
2. 数据校验
   • 用数据模型定义请求和响应的结构
   • 自动校验参数类型和格式
   • 自定义校验规则（如密码强度、两次密码是否一致）
3. 依赖注入
   • 数据库连接的安全获取和释放
   • 当前用户信息的自动注入
   • 自定义依赖的复用和管理
4. 认证授权
   • 用户登录和密码加密存储
   • JWT Token 的生成和验证
   • 接口的权限控制（登录后才能访问）
5. 业务逻辑组织
   • 把业务逻辑从路由层抽离到服务层
   • 事务管理，确保数据一致性
   • 错误处理和异常转换
6. 测试
   • 接口的自动化测试
   • 测试数据库的隔离管理
   • 依赖的模拟和覆盖

怎么用

搭建项目时 —— 告诉它"我要用 FastAPI 开发某某服务"，它会建议项目结构

设计接口时 —— 问它"这个接口的请求参数怎么设计最合理？"

处理认证时 —— 问它"怎么实现用户登录和权限验证？"

写测试时 —— 问它"怎么给这个接口写测试？"

核心原则

做 FastAPI 开发时，记住这几条原则：

1. 分层清晰 —— 路由层只管接收请求和返回响应，业务逻辑放在服务层
2. 依赖注入 —— 通过依赖注入管理数据库连接、用户信息等，不要硬编码
3. 数据校验 —— 用数据模型定义接口契约，自动校验参数
4. 异步优先 —— 数据库操作、网络请求都用异步，提升并发处理能力
5. 安全编码 —— 密码加密存储、Token 安全验证、防止 SQL 注入等
6. 错误处理 —— 统一的错误响应格式，友好的错误提示

典型工作流

1. 定义数据模型 —— 确定接口的请求和响应结构
2. 实现业务逻辑 —— 在服务层编写核心业务逻辑
3. 设计路由 —— 定义 URL 路径和请求方法，调用服务层
4. 配置依赖 —— 设置数据库连接、认证等依赖注入
5. 编写测试 —— 为接口编写自动化测试
6. 部署运行 —— 配置环境变量，启动服务

适用场景

• 基于 FastAPI 的 Web API 开发
• Python 后端服务开发
• 需要用户认证和权限管理的 API 服务
• 需要数据库操作的 CRUD 服务
• 学习 FastAPI 生产级最佳实践

不适用场景

• 纯前端开发（如 React、Vue）
• 非 Python 后端框架（如 Node.js、Java）
• 不需要 API 接口的应用（如命令行工具）
• 已经使用 Django、Flask 等其他 Python 框架的项目