用途
uw-analyze-api 用于分析代码库中的 API 层,覆盖 REST 与 GraphQL 端点、接口契约、认证授权配置以及面向客户端的接口。它是 nearform/unwind 技能集的一部分,输出统一写入 docs/unwind/layers/api/ 目录。
主要能力
- 生成结构化文档目录:index.md 作为入口与端点汇总,配合 endpoints.md、auth.md、contracts.md、errors.md 等分文件。
- 接口契约发现:检索 OpenAPI/Swagger、AsyncAPI、TSRest、tRPC、GraphQL、Protobuf、JSON Schema 等规范文件,要求以完整原文收录而非摘要,并标注为外部契约。
- 端点清单:查找所有 controller 与路由定义,保留实际代码与注解,整理方法、路径、认证要求与处理函数对照表。
- 认证与权限:记录安全配置与权限矩阵,按端点列明认证方式与所需权限。
- 错误处理:收集异常处理器与错误映射模式。
- 路由清单与文档缺口追踪:统计全部路由模块及端点数量,标注未完整记录的模块及原因。
- 强制标签:为每个端点、认证流程、契约等标注 [MUST]、[SHOULD] 或 [DON'T] 分类。
使用方式
技能按增量写入流程执行:先创建目录并写入初始 index.md,然后依次分析并立即写入 contracts.md(优先)、endpoints.md、auth.md、errors.md,每次写入后更新 index.md,最后补全端点汇总表与统计。对于包含 20 个以上路由文件的大型代码库,可按业务域拆分文件。若目标目录已存在,则进入刷新模式,在 index.md 中增加“上次审查以来的变更”章节。
适用场景
适用于迁移或重构前梳理现有 API 表面、需要保留外部契约兼容性的项目,以及为团队建立 API 文档基线。
限制
资料未说明该技能的具体安装命令、运行环境要求、支持的框架版本或自动化程度,这些信息暂未提供。输出内容依赖代码库中实际存在的路由与规范文件,缺失部分需明确记录为文档缺口。