什么是OpenAPI / Swagger 查看器?
OpenAPI(原名 Swagger)是描述 RESTful API 的行业标准规范,通过机器可读的 YAML 或 JSON 文档定义接口路径、请求参数、认证方式与响应数据模型。本查看器无需部署后端 Swagger UI 服务,只需将 OpenAPI 3.x 规范文本粘贴到浏览器中,即可按标签分组直观浏览所有端点定义、状态码与 Schema 结构。
如何使用OpenAPI / Swagger 查看器
- 1先填写“OpenAPI Specification (YAML or JSON)”中的必要内容。
- 2按需修改选项或补充输入,结果会随着页面状态自动更新。
- 3检查结果区域中的输出。
OpenAPI / Swagger 查看器的常见使用场景
无需启动后端服务快速预览接口文档
直接粘贴 OpenAPI 3.x 或 Swagger JSON/YAML 规范文本,即可在浏览器内按分组折叠浏览所有 Path、参数与响应模型。
生成客户端 SDK 前校验 Schema 结构
在运行 openapi-generator 前,直观检查各个接口的请求体(RequestBody)、状态码与引用模型定义是否完整。
架构评审与前后端契约对齐
在接口设计评审会议上粘贴最新的 YAML 草案,快速与前端、移动端团队核对路径命名和字段类型。
常见问题
支持 OpenAPI 3.x 和旧版 Swagger 2.0 吗?
解析器针对现代 OpenAPI 3.0 / 3.1 规范进行了深度优化,支持 JSON 与 YAML 两种格式;旧版 Swagger 2.0 的基础路由也可展示,但部分专有字段建议先升级至 3.x。
粘贴的公司内部接口文档会上传到服务器吗?
不会。所有 YAML/JSON 解析与接口树渲染均在本地浏览器内完成,内部 API 规范绝对不会离开你的电脑。