用途:在冲刺执行期间,为后端与前端智能体创建共享接口文件 api-contract.md,使实现方按约定规范构建,无需直接协调。
主要能力:定义每个端点的 HTTP 方法、路由路径、描述、请求体、响应体与状态码、错误码;为所有请求和响应类型定义 TypeScript 接口,使用显式类型而非 any,可选字段用 ?,可空值用 string | null;列表端点包含分页参数与 PaginatedResponse<T> 包装,统一 page、limit、sort、order;记录成功(200、201、204)、客户端错误(400、401、403、404、422)与空状态,统一错误格式含 code、message 及可选 details;字段约束具体化,附请求/响应示例,引用共享类型避免重复,省略实现细节。
使用方式:需先初始化冲刺目录 .claude/sprint/[N]/ 并准备 specs.md;在冲刺目录创建 api-contract.md,按模板定义端点;在 SPAWN REQUEST 块中共享契约文件路径,供前后端智能体读取同一接口定义。
适用场景:前后端并行开发、需要统一接口规范的冲刺任务。
限制:资料未提供具体安装命令、收费或平台信息;需熟悉 RESTful API 约定与 TypeScript;契约更新须通知双方,避免模式分歧。