用途:把当前可用的需求材料整理成接口规划契约 API清单.md,只整理需求材料、用户确认和已加载 RULE 中已有的规则,不把经验、惯例、模板占位或代码现状补写成新规则。按模板成稿;对象图深度、接口数量、内部入口和停用入口以本次需求为准,没有的章节整节省略。
主要能力:先加载项目上下文(使用已加载的 CONTEXT 术语与 RULE,未加载则按项目知识协议执行,知识不可用时继续并如实说明);汇总需求来源(用户指定,或从当前对话与仓库识别 PRD、需求文档、截图等);收口接口形状,把规划范围内现有公开路由、生成式维护入口及改变资源状态的内部调用标成改造、新增、内部或停用,优先改造已有路由,新路由沿用模块现有 Controller 前缀与 POST /{module}/{method} 风格;无法确认且会改变接口总表、对象图边界、复用还是新增等决策时调用 ask-me 等待用户确认。
使用方式:拟稿并写入,用户指定路径则直接使用,已有需求目录则写入该目录的 API清单.md,否则写入 docs/scratch/<下一个两位序号>-<中文需求名称>/API清单.md,覆盖同名文件无需询问。模板含文档用途、资源与标识、接口总表、场景调用、接口规划、内部入口、停用公开入口等章节。
限制:本文不是 Swagger/OpenAPI,不枚举快照字段、分页外壳和平台通用参数;字段级契约留给实现后的 API 文档,页面显隐、二次确认和节点裁剪留给前端与联调说明。平台通用能力(登录鉴权、BPM 待办与提交/退回/驳回、公共附件上传下载、相邻主数据详情)继续复用,不列入交付接口。代码现状只能用于查证已有实现,不能据此新增需求规则。