Swagger/OpenAPI查看器
在线渲染 OpenAPI 2.0/3.0 规范文档,支持 JSON 和 YAML 格式输入
支持 OpenAPI 2.0 / 3.0 · JSON / YAML
支持拖拽 .json / .yaml / .yml 文件到此区域
点击「渲染文档」查看 API 结构
关于 OpenAPI / Swagger
- OpenAPI 规范(OAS)是描述 RESTful API 的行业标准,前身即 Swagger 2.0
- 当前主流版本为 OpenAPI 3.0 / 3.1,支持 JSON 和 YAML 两种格式
- 规范文件描述了 API 的路径、请求参数、响应结构、认证方式和数据模型
- 常见工具链:Swagger UI(可视化)、OpenAPI Generator(代码生成)、Redoc(文档渲染)
操作说明
- 粘贴 OpenAPI JSON 或 YAML 规范到左侧输入框,点击「渲染文档」
- 支持拖拽
.json/.yaml/.yml文件到输入区域 - 点击「加载示例」可快速体验渲染效果
- 快捷键:Ctrl + Enter 执行渲染
- 接口路径支持折叠展开,点击标题行即可展开查看详情
注意事项
- 本工具为前端轻量级解析,复杂 YAML(锚点、引用等高级语法)建议先转为 JSON
- 规范中的
$ref引用不会自动展开,仅显示引用路径 - 所有数据在浏览器本地处理,不会上传到服务器