[ PROMPT_NODE_25700 ]
Backend To Frontend Handoff Docs 说明文档
[ SKILL_DOCUMENTATION ]
# 后端到前端交接文档
这是一个 Claude Code 技能,可在后端工作完成后为前端开发人员生成全面的 API 交接文档。
## 目的
此技能自动化创建结构化的 API 交接文档,为前端开发人员(或其 AI 助手)提供构建集成和 UI 所需的完整业务和技术背景,无需与后端开发人员反复沟通。
## 何时使用
在以下情况使用:
- 后端 API 工作已完成(端点、DTO、验证、业务逻辑已实现)
- 需要记录 API 变更以供前端集成
- 功能需要在后端和前端团队之间进行交接
- 希望确保前端拥有正确构建集成所需的所有背景信息
- 用户明确要求:“创建交接”、“记录 API”、“前端交接”或“API 文档”
**时机**:在完成后端实现后,前端开发开始前运行。
## 工作原理
1. **分析**已完成的后端代码(端点、控制器、服务、DTO、验证)。
2. **提取**业务背景、约束、边缘情况和注意事项。
3. **生成**包含所有集成细节的结构化 Markdown 文档。
4. **保存**到 `.claude/docs/ai//api-handoff.md`。
5. **版本化**后续更新(v2, v3 等)以跟踪迭代。
### 工作流
后端代码 → 技能分析 → 交接文档 → 前端实现
该技能在“无对话”模式下运行:它仅生成交接文档,不进行讨论或解释。
## 关键特性
### 全面覆盖
- **业务背景**:问题陈述、用户、领域术语
- **端点详情**:方法、路径、认证要求、请求/响应结构
- **数据模型**:TypeScript 接口、字段类型、可空性、枚举
- **验证规则**:必填字段、约束、前端 UX 格式
- **业务逻辑**:非显而易见的行为、边缘情况、注意事项
- **集成指南**:推荐流程、缓存、乐观 UI、实时更新
- **测试场景**:成功路径、错误情况、验收标准
### 智能快捷方式
对于具有明显验证且无复杂业务逻辑的简单 CRUD API,该技能可以跳过完整模板,仅提供:
- 端点 + 方法
- 示例请求/响应 JSON
前端可以推断其余部分。
### 版本管理
自动增加迭代后缀 (