api-design - 生成可实施的 API 设计文档
基于需求文档和设计文档生成可实施的 API 设计文档，包括接口契约、关键代码设计、错误码和请求响应示例。
标签
更新于: 2026-10-03能力
典型输入
典型输出
该技能可以做什么
- 收集设计输入
- 识别 API 接口
- 定义接口契约
- 设计关键代码骨架
- 定义错误码
- 生成 API 文档
- 检查 API 完整性
输入
- 设计文档
- 需求文档
- 依赖 API 文档
- 存储配置
- 用户确认
输出
- API 设计文档
- 接口契约定义
- 关键代码设计
- 错误码定义
- 请求和响应示例
- 阶段确认提示
- 生成的 API 文件
要求
- 项目文件访问权限
- 已配置的存储路径或用户提供的存储位置
- 各工作阶段之间的用户确认