用途:该技能扮演 API 设计专家,读取用户故事形式的需求,产出前后端之间的 API 契约(规范文档)。它定义 API 暴露什么(WHAT),而非如何实现(HOW),每个用户故事映射到一个或多个端点。\n\n主要能力:解析需求中的角色、功能、收益与业务规则;自动扫描项目以检测已有 API 约定(基础路由、响应包装、认证头、分页风格、ID 类型),无项目时使用 REST 默认约定;按故事模式映射 REST 端点(创建 POST、查看 GET/{id}、列表 GET、更新 PUT/{id}、删除 DELETE/{id}、自定义动作 POST/{id}/{action});按故事角色映射权限(Admin 全访问、Manager 读加有限写、User 仅读自身数据、System 内部无认证、Guest 公开);定义每个端点的请求体、查询参数、响应体、错误响应与字段校验规则。\n\n使用方式:用户提供需求文件路径(.md 或 .txt),或由技能用 find 命令自动探测并审阅文件;随后扫描项目检测约定,生成 {feature-name}-api-spec-{YYYY-MM-DD}.md 规范文档并打印汇总。文档可再输入 api-spec-to-technical-plan 技能生成技术方案。\n\n适用场景:已有用户故事、需要先确定 API 契约再进入前后端实现的团队。\n\n限制:只产出 API 规范,不含实现细节与代码片段;自定义动作、搜索过滤、文件上传等需按规则适配;字段类型歧义、故事未说明收益或业务规则不清时,会标记为开放问题或假设;具体收费与价格暂未提供。
user-stories-to-api-spec
编程与开发
更新于 10-16 06:14