用途:在并行实现前,为消费方与提供方建立一份可测试的 API 合同,将需求与高层设计翻译为可落地的接口规范,输出 API_Specification.md 与 openapi.yaml。适用于已批准需求、HLD(高层设计)与消费方用例确定之后,与低层设计、数据库设计并行。不适用于内部方法设计、数据库模式设计或编造未定义端点。
主要能力:从 SRS 第 3.2 节提取实体与操作形成资源与端点;按 REST 约定映射 CRUD 到 HTTP 方法;定义认证方案(JWT Bearer、Session Cookie 或 API Key);逐端点定义路径、参数、请求/响应模式与状态码;用 RFC 9457 问题详情统一错误格式;定义限流、分页、版本策略与溯源矩阵;可选支持长时运行操作、批量操作、自定义方法与字段掩码。
必要输入:SRS_Draft.md、HLD.md、tech_stack.md,缺失即停止执行。工作流程为读取并确认输入批准状态,按决策规则产出规范与有效 OpenAPI 3.1 文档,逐条溯源,验证可观察验收条件并交付。
标准与限制:遵循 OpenAPI 3.1.x(3.1.2)、JSON Schema 2020-12、RFC 9457、RFC 9110、IEEE 29148-2018。默认只读,编辑仅限交付物;不得发布、变更生产、批准政策或声称认证。任一步骤能力不可用时返回带缺口登记表的最窄草稿,且不得把未评估检查记为通过。限流头部方案须记为项目决策,不得称为标准;若旧客户端契约已固定不同错误包络,须记录决策、责任人与迁移日期。