用途:根据用户代码库自动生成或更新 OpenAPI 3.0 规范(Swagger 定义),适用于需要从现有路由和端点创建或维护 API 定义的场景。
主要能力:扫描 Express/Node.js、Python(Flask/Django/FastAPI)、Go、Java(Spring)、Ruby(Rails)等框架的路由定义,提取 HTTP 方法、URL 与路径参数、查询参数、请求体结构、响应结构、认证要求与状态码;检测已有规范并保留原有描述、示例和自定义字段;使用 $ref 复用组件 schema;通过 operationId、tags、security 组织规范;从配置文件或代码常量探测端口。
使用方式:由具备读文件与执行命令能力的智能体执行。先按框架搜索路由文件并读取源码,再检查 postman/specs 及根目录是否已有规范;随后读取 references/spec-template.md 并生成 YAML 规范,新规范写入 postman/specs/openapi.yaml;最后用 Postman CLI 校验:postman spec lint ./postman/specs/openapi.yaml,可选 --fail-severity WARNING、--output JSON、--workspace-id <workspace-id>,并循环修复直到无错误无警告。Postman CLI 未安装时提示 npm install -g postman-cli。
适用场景:为已有代码库补全或更新 API 规范、保持规范与代码同步、应用团队治理与安全检查。
限制:仅依据实际代码生成,不虚构端点或 schema;无法识别框架或找不到路由时需用户指明文件;必须通过 Postman CLI 校验后才算完成;必须使用 OpenAPI 3.0.3 与 YAML 格式;新规范位置固定为 postman/specs/openapi.yaml。收费、平台适用性等资料未提供。