OpenAPI / Swagger 文档查看器

粘贴或导入 OpenAPI 3.x、Swagger 2.0 的 JSON 或 YAML 文件,按标签分组列出所有接口,查看参数、请求体、响应结构和示例,自动解析 $ref 引用,为每个接口生成 curl 命令,并检查文档中的常见问题。文件只在浏览器本地解析,不需要部署 Swagger UI。

编辑文档(当前为示例:图书商城接口)
导入 openapi.json / openapi.yaml支持 OpenAPI 3.0、3.1 和 Swagger 2.0

数据结构

OpenAPI 文档的结构

  • info 和 servers:接口的名称、版本、说明和服务器地址。
  • paths:每个路径下按 HTTP 方法列出操作,包含参数(parameters:路径、查询、请求头、Cookie)、请求体(requestBody)和各状态码的响应(responses)。
  • components / definitions:可以复用的数据结构,通过 $ref: "#/components/schemas/Book" 引用,避免重复定义。Swagger 2.0 中写在 definitions 下。
  • OpenAPI 3.1 与 JSON Schema 完全兼容:3.1 的 schema 就是 JSON Schema 2020-12,可以用 type: ["string", "null"];3.0 使用 nullable: true。
  • 从代码生成文档:多数框架可以自动生成 OpenAPI 文档,例如 FastAPI 自带 /openapi.json,Spring Boot 使用 springdoc-openapi,NestJS 使用 @nestjs/swagger,Go 可以用 swag。

调试 GraphQL 接口请用 GraphQL 调试器,查看接口返回的 JSON 请用 JSON 树形查看器,用 Schema 校验数据请用 JSON Schema 验证器。

OpenAPI / Swagger 文档查看器常见问题

OpenAPI / Swagger 文档查看器怎么使用?

展开“编辑文档”粘贴 OpenAPI 的 JSON 或 YAML,或者导入文件;页面按标签分组列出接口,点击展开查看参数、请求体、响应结构和 curl 示例,可以搜索接口、切换服务器地址;下方列出数据结构和文档中的问题。

OpenAPI 和 Swagger 是什么关系?

Swagger 2.0 是 OpenAPI 的前身,3.0 起更名为 OpenAPI 规范,Swagger 现在指一套工具。

怎么查看 openapi.yaml?

把文件拖进本页面,即可按标签浏览所有接口。

能根据文档生成请求示例吗?

每个接口都会生成 curl 命令,请求体会根据 example 或数据结构自动填充。

$ref 是什么?

引用文档中其他位置定义的数据结构,本工具会自动展开显示。

OpenAPI / Swagger 文档查看器的结果应怎样理解?

只解析文档内的 $ref 引用,外部文件引用无法解析;不能直接发送请求,可以复制 curl 在终端中执行。

输入内容会保存或发给外部服务吗?

文档只在浏览器本地解析,不会上传。

没有结果或操作失败时先检查什么?

提示无法解析时,检查 YAML 的缩进是否正确;没有显示接口时确认文档中有 paths 字段。

相关工具

API 接口模拟 · cURL 命令生成器 · Docker Compose 生成器 · GeoJSON 在线查看与校验 · 全部开发工具