祈灵工具箱

🛎️OpenAPI / Swagger 在线查看器 - 接口文档预览、校验与导出

拿到一份 openapi.yaml 或 swagger.json,却不想为了看一眼就部署 Swagger UI?把文档粘贴进来或打开本地文件,工具会在浏览器里把它整理成可读的接口文档:顶部是标题、版本、描述、服务器地址和鉴权方式;左侧按标签分组列出全部接口,带彩色的请求方法标记,可按路径、摘要、operationId 或标签搜索;右侧显示选中接口的参数表、请求体和各状态码的响应。所有 $ref 引用都会被解析成可逐层展开的模型树,显示类型、必填、枚举、取值范围、readOnly 等约束,遇到循环引用会标出“↻”而不会无限展开,并按 schema 自动生成示例 JSON(请求体会跳过只读字段)。Swagger 2.0 的 body / formData 参数和 definitions 会自动转换成与 OpenAPI 3 相同的结构。“调试”面板可以选择服务器、填写参数和令牌,实时生成 curl 与 fetch 代码;勾选确认后也可以直接从浏览器发送请求(需要目标服务器允许跨域)。工具还会给出校验提示:无法解析的引用、缺少或重复的 operationId、只有参数名不同的重复路径、路径参数未定义等。最后可以一键导出一份独立的静态 HTML 文档发给同事。文档内容只在本地处理,不会上传。

免费 · 无需注册 · 浏览器本地处理最后更新:

正在加载工具...

如何使用OpenAPI 文档查看器

  1. 1粘贴 OpenAPI / Swagger 的 JSON 或 YAML,或打开本地文件(也可先点“示例文档”看看效果)
  2. 2在左侧按标签浏览或搜索接口,查看参数、请求体、响应模型和示例 JSON
  3. 3在“调试”面板生成 curl / fetch 代码,或导出静态 HTML 文档

常见问题

和 Swagger UI、Redoc 有什么区别?
展示的内容类似,但这里不需要部署任何服务,也不用把文档上传到第三方网站:粘贴即看,全部在浏览器本地解析。另外会额外给出校验提示,并能导出一份不依赖任何脚本的静态 HTML 文档,方便发邮件或放进内网 Wiki。
支持外部文件引用($ref: other.yaml#/...)吗?
不支持。为了不发起网络请求,只解析同一文档内的引用(以 # 开头的 JSON Pointer)。外部引用会在校验提示里列出;可以先用 swagger-cli bundle 或 redocly bundle 把多个文件合并成一个再粘贴。
“发送请求”为什么失败了?
请求是从你的浏览器直接发往接口服务器的,本站不做中转。如果服务器没有返回允许当前来源的 CORS 响应头,浏览器会拦截响应,就会显示请求失败。这种情况下可以复制生成的 curl 命令到终端执行,结果是一样的。
循环引用的模型会怎样显示?
比如分类 Category 的 parent 字段又指向 Category,模型树展开到重复出现的地方会显示“↻ 循环引用”并停止,示例 JSON 也会在那里截断,所以再复杂的递归结构也不会卡死页面。