用途:审计遗留应用的 API 表面,精确记录其行为,以便用现代框架(如 Next.js Route Handlers)重建。
主要能力:定位路由与控制器,将 API 划分为主资源与子资源,识别通用返回包络与状态码模式,逐端点记录方法路径、中间件、入参、出参和错误状态,最终产出 API_Contracts.md,并识别必要的路由重定向与一致性探针。
使用方式:可由审计子代理按清单执行五步流程——1) 在遗留代码库中查找端点定义(如 config/routes.js、routes/ 或 app.js/server.js)并追踪到控制器函数;2) 按主资源(Users、Products、Posts 等)与子资源(如 Post 的 Comments、Product 的 Reviews)分类;3) 识别通用响应包络(如 { success: true, data: [...], meta: { total: 100 } } 或直接返回对象/数组)及成功、校验失败(400/422)、授权失败(401/403)的常见状态码;4) 记录每个端点的 Method & Path、中间件分析、入站数据(req.body/query/params,必填与可选、数据类型)、出站结构、错误状态处理;5) 将结果汇总到 docs/legacy-audit/API_Contracts.md,并把所有端点列入清单,供后续脚手架阶段核对;同时识别路由重定向,并把一致性探针追加到 docs/verification/Verification_Plan.md。
适用场景:遗留 Express 应用现代化改造前的 API 逆向梳理与文档化。
限制:资料未提供具体安装方式、依赖环境或支持的 Express 版本;步骤中的路径为示例,实际需按项目调整。