OpenAPI/Swagger 规范校验器

校验OpenAPI 3.x文档基础结构(openapi/info/paths),按path分组可视化展示接口列表,并检测缺少responses、重复operationId等常见问题,当前仅支持JSON格式。

免费在线工具
Loading…

使用说明

  1. 在文本框中粘贴 OpenAPI(Swagger)文档的 JSON 内容。
  2. 点击「校验并解析」,工具会检查 openapi 版本号字段、info.title/info.version 必需字段、paths 是否存在且非空。
  3. 校验通过后,下方「接口列表」会按 path 分组展示所有接口的 HTTP 方法、summary/description、operationId。
  4. 工具还会给出警告(不阻断解析):缺少 responses 定义、缺少 summary/description、operationId 重复。
  5. 点击「加载示例OpenAPI文档」查看一个包含警告示例的完整文档,帮助理解各项检测规则。

功能介绍

  • 基础结构校验:openapi 版本号字段、info.title/info.version 必需字段、paths 非空。
  • 按 path 分组可视化展示所有接口,包括 HTTP method、summary/description、operationId。
  • 常见问题警告检测:缺少 responses 定义、缺少 summary/description、operationId 重复出现。
  • 当前仅支持 JSON 格式的 OpenAPI 文档解析(不含 YAML 解析器),如果检测到疑似 YAML 输入会明确提示,不会伪装成功;如需校验 YAML 版本,请先用站内「YAML转JSON」工具转换。
  • 识别 Swagger 2.0(swagger 字段)文档并明确提示暂不支持,避免误判校验结果。
  • 纯本地解析,不上传文档内容。

使用场景

API 文档提交前自查
团队在提交/合并 OpenAPI 文档前,先用本工具快速检查基础字段是否齐全、是否有遗漏 responses 的接口。
第三方接口文档速览
粘贴第三方开放平台提供的 OpenAPI JSON,快速以列表形式浏览所有可用接口及其说明,无需下载专门的 Swagger UI。
operationId 命名规范检查
校验大型 API 文档中是否存在重复的 operationId,避免代码生成工具(如 openapi-generator)因重复 ID 报错或生成错乱。
接口文档完整性审查
排查文档中缺少 summary/description 的接口,作为技术文档评审的辅助检查工具。

常见问题

支持 YAML 格式的 OpenAPI 文档吗?
当前仅支持 JSON 格式,不含 YAML 解析器。如果粘贴的是 YAML 内容,工具会检测并明确提示“仅支持JSON格式”,不会假装校验通过;建议先用站内「YAML转JSON」工具转换后再使用本工具。
支持 Swagger 2.0 吗?
暂不支持。工具会检测文档中的 swagger 字段并提示“当前仅支持 OpenAPI 3.x”,不会强行按 OpenAPI 3.x 规则误判 Swagger 2.0 文档。
会校验 $ref 引用和 Schema 的详细类型定义吗?
不会。本工具只做基础结构校验(openapi/info/paths字段)和常见问题警告(responses/summary/operationId),不做 $ref 引用解析、Schema 深度类型校验等完整规范校验,如需完整校验请使用专业的 OpenAPI 校验工具。
文档内容会上传吗?
不会,所有解析和校验都在浏览器本地完成。