用途:将 SRS 中的功能需求与 HLD 中的架构决策转化为可实施的 API 契约,输出人类可读的 API_Specification.md 和机器可读的 openapi.yaml。适用于后端开发前的正式 API 契约制定,可在 01-high-level-design 完成后运行,与 02-low-level-design、04-database-design 并行。
主要能力:从 SRS 3.2 提取实体与操作,按 REST 约定映射 CRUD 到 HTTP 方法;从 SRS 3.5.3 提取认证机制(JWT Bearer、Session Cookie 或 API Key);为每个端点定义路径、方法、参数、请求/响应模式与状态码;定义统一错误响应格式、限流(含 X-RateLimit-* 头)、分页策略;可选支持长时操作、批量操作、自定义方法与字段掩码等高级模式;生成含 info、servers、paths、components/schemas、securitySchemes 的 OpenAPI 3.0.3 文档,并建立端点与 SRS 需求 ID、HLD 组件的追溯矩阵。
使用方式:需提供 projects/<ProjectName>/<phase>/<document>/SRS_Draft.md、HLD.md 及 projects/<ProjectName>/_context/tech_stack.md 三个必需输入;按十一步流程执行,缺失必需文件时中止并报告。输出至同目录下的 API_Specification.md 与 openapi.yaml。
适用场景:需要正式 API 契约的后端开发、API 测试用例设计,以及公开、合作方、工作流密集或长期存续的 API。
限制:资料未提供具体安装命令、收费信息或平台支持细节;高级模式为可选,需相应参考文件支持。