用途:根据自然语言描述、源代码或已有部分规范,生成完整、有效的 OpenAPI 3.x 或 Swagger 2.0 规范,输出 YAML(默认)或 JSON。
主要能力:先收集上下文(版本、输出格式、API 用途、端点列表、认证类型、数据模型、是否合并已有规范);按所选版本生成完整骨架,不保留 TODO 占位;用 $ref 复用 schema,为每个 schema 和响应体提供示例,用 required 标注必填字段;支持 Bearer JWT、API Key、OAuth 2、Basic Auth、OpenID Connect 等安全方案,并全局应用、按操作覆盖;文档化路径、查询、请求头参数;覆盖 200/201/204/400/401/403/404/409/422/429/500 等响应码;交付前按质量清单校验版本字段、operationId、响应、$ref、必填字段、安全方案、示例与标签。
使用方式:提供代码时自动提取端点,例如 Express/Koa/Fastify 的 .get()/.post() 等调用、FastAPI/Flask 装饰器与 Pydantic 模型、Spring 的 @GetMapping/@PathVariable、Django REST 的 ViewSet/Serializer、Rails 的 routes.rb。生成后可导出 .yaml/.json、用 Spectral 或 swagger-parser 校验、生成 Prism mock 配置或客户端 SDK 桩。
适用场景:设计新 API、从现有代码反向生成文档、补全部分规范、统一认证与错误响应结构。
限制:资料未提供具体安装命令、收费与价格信息;生成质量依赖输入上下文的完整程度。