如何让 AI 快速生成规范的 FastAPI 路由代码 #

解决后端开发中路由编写重复且易出错的问题：通过标准化的模板和模式，让 AI 快速生成包含鉴权、响应模型和标准状态码的 FastAPI 路由模块。

为什么需要这个技能 #

在构建中大型 FastAPI 项目时，路由编写往往存在不统一的问题。例如，有的开发者在某些接口中遗漏了响应模型（Response Model），导致 API 泄露了数据库敏感字段；或者在创建资源时忘记设置 201 Created 状态码，导致前端无法准确判断请求结果。

通过此技能，AI 将不再随机猜测代码结构，而是严格遵循一套工业级模式：统一的命名约定、强制的响应模型校验以及标准化的身份验证依赖，确保生成的代码直接符合生产环境的质量要求。

适用场景 #

• 需要快速为新资源（如 Project, User, Order）搭建一套完整的 CRUD 路由。
• 团队需要统一 API 规范，确保所有路由的鉴权逻辑和状态码返回一致。
• 在从需求文档快速转化为后端代码原型时。

核心工作流 #

1. 模板实例化：利用 assets/template.py 中的占位符进行快速替换。

   • {{ResourceName}} $\to$ 大驼峰命名（如 Project）
   • {{resource_name}} $\to$ 蛇形命名（如 project）
   • {{resource_plural}} $\to$ 复数形式（如 projects）

2. 配置身份验证模式：

   • 可选鉴权：使用 Optional[User] = Depends(get_current_user)，允许匿名访问但可识别登录用户。
   • 强制鉴权：使用 User = Depends(get_current_user_required)，未登录直接触发 401 错误。

3. 定义响应与状态码：

   • 为所有 GET 请求配置 response_model，确保数据过滤。
   • 为 POST 请求配置 status.HTTP_201_CREATED，为 DELETE 请求配置 status.HTTP_204_NO_CONTENT。

4. 集成部署：

   • 在 src/backend/app/routers/ 创建路由文件 $\to$ 在 main.py 中挂载路由 $\to$ 定义 Pydantic 模型 $\to$ 实现 Service 层逻辑。

下载和安装 #

下载 fastapi-router-py 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹，重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。

你可能还需要 #

暂无推荐