无需登录 数据私有 本地保存

OpenAPI/YAML 规范校验器 - 实时检查与错误提示

12
0
0
0
OpenAPI 校验器 支持 OpenAPI 3.0 / 3.1 & Swagger 2.0
拖放 YAML 文件到此处
等待校验
错误 0 警告 0 路径 0

输入 YAML 内容开始校验

支持 OpenAPI 3.0、3.1 及 Swagger 2.0 规范

常见问题

OpenAPI 规范（原名 Swagger）是一种用于描述 RESTful API 的标准化格式。它允许开发者定义 API 的端点、请求参数、响应格式、认证方式等，是 API 设计和文档的事实标准。目前最新版本为 OpenAPI 3.1，兼容 JSON Schema 2020-12。

OpenAPI 3.0 引入了 components 结构（替代 definitions）、支持 multiple servers、增强了安全性定义、支持 oneOf/anyOf 等高级 Schema 特性、新增了 requestBody 独立定义等。Swagger 2.0 使用 swagger: "2.0" 标识，而 OpenAPI 3.0 使用 openapi: "3.0.x"。

本工具会精确显示 YAML 解析错误的行号。常见 YAML 错误包括：缩进不一致（混用空格和Tab）、冒号后缺少空格、多行字符串格式错误、重复的键名等。点击带有行号的错误项可直接跳转到编辑器中对应位置。

本工具校验：① YAML 语法正确性；② 顶层必填字段（openapi/swagger、info、paths）；③ info 中 title 和 version 必填；④ paths 路径格式（须以 / 开头）；⑤ 每个 Operation 必须有 responses；⑥ responses 至少包含一个状态码响应；⑦ servers/components 类型正确性等。同时提供最佳实践警告建议。

YAML 规范中注释（# 开头的内容）不属于数据的一部分，序列化工具（如 js-yaml 的 dump 方法）不会保留注释。格式化本质是解析后重新序列化的过程。建议在最终定稿前保留注释版本，或使用支持注释保留的专业工具。
🔧 相关工具