SuperAPI AI 工具集

backend-to-frontend-handoff-docs

编程与开发

查看项目

更新于 10-15 23:31

技能介绍

用途:在后端 API 开发完成后,为前端开发者(或其 AI 助手)生成一份可直接复制使用的交接文档,使其无需再向后端提问即可正确完成集成与界面开发。

主要能力:整理功能名称、相关端点、DTO、鉴权规则与边界情况;按模板填写各章节,包含真实示例请求/响应载荷、类型与约束、枚举与校验规则;记录后端做出的取舍与假设,以及非显而易见的特殊行为。若 API 较简单(如 CRUD、无复杂业务逻辑、校验直观),可跳过完整模板,仅提供端点、方法与示例请求/响应 JSON。

使用方式:收集已完成 API 代码(端点、控制器、服务、DTO、校验)及任务/用户故事中的业务上下文;将文档写入 .claude/docs/ai/<feature-name>/api-handoff.md,若因反馈重跑则递增版本后缀(-v2、-v3 等);读取 references/handoff-template.md 并逐节填写具体数据,仅在确实不适用时省略子章节并说明原因;最后核对载荷与实际 API 行为一致、鉴权范围准确、枚举与校验反映后端逻辑。

限制与规则:仅输出交接 Markdown 文档,不在对话中输出讨论或解释;不包含后端实现细节(文件路径、类名、内部服务),除非与集成直接相关;内容需精确、可快速浏览,使用标题、表格、列表与代码块;未完成或待定事项须明确标注。