01
先看版本和输入边界
校验规则取自根字段 openapi 或 swagger。OpenAPI 3.1 可以只有 components，空端点列表不一定代表文档无效。
- 内置示例同时展示共享路径参数和递归模型引用。
API 工具
OpenAPI 编辑器看清接口契约
粘贴 JSON 或 YAML 规范，从端点查看参数与响应，修正诊断后导出所需结果。
OpenAPI 编辑器
OpenAPI 规范原文
结果
没有匹配的请求端点。
已显示 0 / 0 项
规范仅在此浏览器内处理，不发送 API 请求，也不抓取远程引用。
输出选项
检查规范结构与常见路径规则。端点导出只覆盖 paths，不包含 webhook 和 callback；不测试示例值或真实响应。
输入上限 500,000 字符、60 层、50,000 节点、100 条诊断，校验时限 5 秒。
粘贴规范或载入示例。
复制与下载对应所选视图。端点导出始终包含完整列表，不受搜索过滤影响。
拿到一份自动生成的接口文档时，能解析并不代表定义正确。OpenAPI 编辑器把规范原文、接口操作和诊断放在同一处，帮助你找到缺少响应描述、路径参数未声明或共享定义失效的位置。
先核对 openapi 或 swagger 标明的版本，再看具体错误。整理缩进不会迁移规范，也不能证明已部署接口会按文档返回数据。
为什么使用 OpenAPI 编辑器
把文档中的问题对应到真正受影响的接口。
路径与参数一起读
OpenAPI 编辑器按请求路径整理操作。展开方法后可查看继承参数、请求体、响应状态、安全声明和服务器配置。搜索只缩小当前列表，不改变导出清单，适合核对某组接口后把完整清单交给同事。
引用未检查就明确标出来
同文档 JSON Pointer 引用会检查目标是否存在。递归模型保留引用关系，缺失目标会报错；外部文件和 URL 引用保留原样并提示检查不完整，不会悄悄当作已经验证。
交付接口文档前的三项核对
02
检查合并后的有效参数
展开操作，核对参数名称、位置及必填状态。操作级参数按相同名称和位置覆盖路径级参数，不会多生成一个参数。
- 关闭自动校验后，可用 Ctrl/Cmd + Enter 手动运行。
03
按用途选择导出视图
格式化规范适合继续编辑；端点视图导出完整 JSON 清单；Markdown 视图生成包含参数、请求体和响应定义的评审文档。
- 修改原文或输出参数后，复制与下载会禁用，直到新结果完成。
从规范校验到接口清单
按版本检查规范结构
OpenAPI 校验使用实际的规范模式区分 Swagger 2.0、OpenAPI 3.0 与 3.1，并检查 3.1 内标准 JSON Schema 2020-12 关键词的形状。错误类型名和操作字段缺失都能形成诊断。
核对路径与操作的一致性
作为 Swagger 校验器，它会检查重复操作 ID、同列表重复参数、路径占位符漏声明及非必填路径参数。路径条目中的 servers、parameters 和扩展字段不会被误算成 HTTP 操作。
整理缩进和转换序列化格式
OpenAPI 格式化提供 2 或 4 空格缩进，支持 YAML 转 JSON，也能反向输出 YAML。格式转换保留版本字段和引用字符串，不会替你把旧版 Swagger 自动升级。
生成便于评审的文档
Markdown 导出包含 API 信息、服务器以及各操作的参数、请求体、响应和安全声明。描述内容会转义，代码块会安全封装，页面不会执行规范里夹带的 HTML。
校验和导出的具体边界
- 单份文档与已支持版本
- 支持 Swagger 2.0、OpenAPI 3.0.x 与 3.1.x，明确拒绝 3.2 和其他规范家族。本地引用指同一份文档内的引用，不代表读取任意本地文件或整个目录。
- 外部引用与高级作用域
- 远程 URL 和相对文件引用不会抓取。Schema 资源 ID、锚点、动态引用和自定义方言会标明检查不完整；如需完整依赖检查，请先在可信环境内合并文档。
- 保留值，重新生成 YAML 表现形式
- 输出不保留 YAML 注释和引号样式。仅接受字符串键、单文档 YAML 1.2，不接受锚点、别名、合并键与自定义标签；重复键和会丢失精度的数字也会阻止处理。
- 端点清单只列普通请求操作
- 树和清单覆盖 paths 下的操作。Webhook 与 callback 仅检查结构，不纳入清单及路径语义检查。示例值、真实响应、鉴权和业务行为需要另外测试。
- 超过预算会停止，而不是截断成成功
- 输入最多 500,000 字符、60 层、50,000 节点；超过 100 条诊断、2,000,000 字符结果或 5 秒计算预算会停止。大型契约应拆分检查，不应把失败当成部分通过。
OpenAPI 编辑器常见问题
支持 YAML 格式的规范吗？
支持 JSON 与 YAML，输出格式可以单独选择。YAML 必须是单份 1.2 文档，状态码等映射键请用字符串形式；无法表示的结构会明确报错。
支持 Swagger 2.0 吗？
支持，工具会读取 swagger: "2.0" 并采用对应规则。格式化只改变 JSON 或 YAML 的表示形式，不会把 definitions、body 参数等字段迁移成 OpenAPI 3。
会校验 $ref 引用和 Schema 的详细类型定义吗？
会检查文档结构、标准模式关键词及同文档指针目标，也会补充常见参数诊断。远程引用和高级方言明确标为未完整检查；不会拿示例数据或真实响应去做实例校验。
文档内容会上传吗？
不会。输入在浏览器工作线程中解析与校验，不发送接口请求，也不加载规范中的远程引用。关闭或刷新页面后没有自动恢复原文的功能。
OpenAPI 3.x 文档必须包含哪些字段？
需要 openapi 和包含 title、version 的 info。3.0 要求 paths；3.1 可以通过 paths、components 或 webhooks 描述内容，不能简单把所有缺少 paths 的文件判错。
遇到未覆盖的文档情况？