用途:让 API 文档与代码实现保持一致。提供两种模式:Generate(从路由生成规范)与 Validate(规范与路由互校),使用前先确认适用模式。
主要能力:发现阶段会扫描路由挂载前缀、循环或配置数组注册的动态路由、兼作终结请求的中间件、嵌套路由,以及 NestJS、FastAPI、Django、Hono 等框架的特定写法;同时从路径参数、查询参数、响应结构、Zod/Pydantic/Joi 等校验 schema 和错误响应中提取信息。生成模式可产出 OpenAPI 3.1.0(或按代码库推断版本)的 YAML/JSON,支持合并已有部分规范并保留人工撰写的描述;校验模式会解析规范中的 servers 基路径,归一化 {param} 与 :param 后比对,将结果分为幽灵路由、未文档化路由和漂移三类,并给出修复建议。
使用方式:按发现、策略、执行、输出四阶段推进;生成时增量构建 paths 与 components/schemas,用 handler 名生成 operationId,按首段路径分组 tags;校验时输出结构化差异报告,可选择性自动补桩、删除幽灵路由或标记漂移。写入前始终确认,不会静默修改规范。
适用场景:维护 OpenAPI/Swagger 文档、排查文档与实现不一致、为已有代码补全接口文档。
限制:需人工确认模式与输出位置;版本化 API、文件上传、流式端点、健康检查等内部路由需特殊处理;无响应类型信息时不臆造结构。具体安装与调用命令资料未提供。