OpenAPI 查看

怎么用

1. 把文档粘贴进左侧面板 —— JSON 或 YAML 都认。
2. 点解析文档，右侧面板会填上摘要：标题、版本、服务器，然后是每个路径。
3. 每个操作行显示方法、路径、说明、参数（位置与是否必填）、请求体的内容类型，以及响应码加一层 schema 类型摘要。
4. 文档非法时，错误行会说明到底缺了哪个字段、或者哪段解析失败。
5. 复制或下载摘要，贴进工单、评审或 README。

常见用法

• 动手前过一遍接口 —— 不开编辑器就能读完每个端点、入参和出参。
• 分享 API 概览 —— 把摘要贴进聊天或工单，不用甩整份文档。
• 检查生成的文档 —— 确认路径、参数、响应码是否符合预期。
• 学 OpenAPI 结构 —— 在真实例子里看 info、servers、paths、components 怎么拼。

常见问题

问：支持哪些版本？ 答：OpenAPI 3.x 与 Swagger 2.0。版本字段必填，缺失时错误信息会直说。

问：schema 摘要有多深？ 答：一层。对象的属性按名称列出并带类型，嵌套对象显示为引用名或简短类型说明。它是 API 地图，不是完整的 schema 浏览器。

问：$ref 指针怎么显示？ 答：按目标名显示，例如 ref:Book。工具不会把它解析回 components —— 摘要保持可读。

问：YAML 解析失败怎么办？ 答：错误行带有 js-yaml 的原始信息，通常能指到出问题的行。制表符缩进和引号不闭合是最常见的原因。