什么是 OpenAPI
OpenAPI(旧称 Swagger)是 REST API 的标准机器可读格式:openapi.json 描述每个端点、方法、参数、schema 和服务器。团队之间分享这些规范,用于生成客户端、文档和测试——也用来争论 API 到底是怎么工作的。
这个查看器能做什么
- 解析 JSON(如需 YAML,请先转换为 JSON——稳妥起见请粘贴 JSON),并列出每个路径及其方法。
- 显示每个操作的摘要/描述和参数数量;安全块保留在原始规范中,需要时可直接查看。
- 全程本地运行——API 规范常包含内部 URL 和 schema;数据不会离开你的标签页。
- 快速浏览——需要完整的交互式文档(试运行、模型 schema)时,请用 Swagger UI 或 Stoplight;本工具主打快速查看。
快速检查
- 每个路径都有你预期的 get 方法吗?
- 参数是定义在路径级别还是操作级别(一个经典的不一致问题)?
- 有没有 security 块——认证方案和你的客户端库匹配吗?
- 版本不匹配:info.version 字段会告诉你当前看的是哪一版规范。