OpenAPI 验证器
在浏览器中即时验证 OpenAPI 3.0 和 3.1 规范(YAML 或 JSON),检查必填字段、路径结构、接口响应,并显示规范摘要。纯浏览器端运行。
使用方法
- 将 OpenAPI 规范(YAML 或 JSON)粘贴到编辑器中。
- 点击验证或按 Ctrl+Enter。
- 若有效,摘要面板将显示 API 名称、版本、路径数量和操作数量。
- 若无效,每个错误将以 JSON 路径和描述的形式列出。
OpenAPI 3.x 必填字段
openapi— 版本字符串,如“3.0.3”或“3.1.0”info.title— API 名称info.version— API 版本,如“1.0.0”paths— 路径条目映射,每个键必须以/开头
常见错误
- 使用 Swagger 2.x 格式(
swagger: “2.0”)而非 OpenAPI 3.x — 将swagger替换为openapi: “3.0.3”,并将definitions更新为components/schemas。 - 操作中缺少
responses对象 — 每个操作必须声明至少一个响应。 - 路径键不以
/开头 — 所有路径必须是绝对路径,如/users/{id}。 - YAML 缩进错误 — 请先使用 YAML 语法验证器 修复语法问题。
FAQ
支持哪些 OpenAPI 版本?
验证器支持 OpenAPI 3.0.x 和 3.1.x 规范。Swagger 2.x (OpenAPI 2.0) 文档将显示版本提示和迁移建议。
可以验证 YAML 和 JSON 格式吗?
可以。粘贴 YAML 或 JSON 均可,工具会自动检测格式并解析。
验证器会检查哪些内容?
顶层必填字段(openapi、info、paths)、info 对象字段(title、version)、路径格式(必须以 / 开头)以及每个操作是否包含 responses 对象。
我的 API 规范会被发送到服务器吗?
不会。所有验证在浏览器中通过 JavaScript 完成,不会向任何服务器传输数据。
OpenAPI 3.x 文档的必填字段有哪些?
openapi(版本字符串)、info.title、info.version 和 paths。servers、components、tags 和 externalDocs 是可选字段。