json - 针对 Swagger API 模式验证 JSON

Question

我从一些 JSON 文件创建了一个 API 规范，我正在尝试测试这些文件是否符合 API 规范。

有一些很好的工具可以验证 JSON 模式，但我没有机会找到一个工具来验证 Swagger 中创建的规范(用于创建 API 模式的工具)。我找到的唯一解决方案是在 Swagger-Editor 中生成客户端/服务器，这很麻烦。

是否已有工具可以根据 Swagger Schema 验证 JSON？

Answer 1

评论中的 Arnaud 是正确的，这里有两个单独的问题。

Do you want to validate that your spec is a valid OpenAPI (fka. Swagger) spec

你可以

• 将您的规范复制到 online Swagger editor它会抛出错误。快速浏览 source没有告诉我它是用什么来创建这些错误的，但它似乎没有联系服务器来做这件事......
• 使用官方swagger-parser用于 Java。
• 使用非官方swagger-parser用于 JavaScript(浏览器或节点)。

or validate that an implementation of this spec would produce JSON which is valid regarding your JSON schemas?

换句话说，这是来自请求或响应正文的一些 JSON，是否正确？

Swagger 的 schema objects 依赖于另一个名为 JSON Schema 的标准。 ，这是实际描述 JSON(而不是端点或元数据)的内容。 Swagger 使用 JSON Schema 的子集(缺少:oneOf、patternProperties 等)。为此，您可以使用 JSON 模式验证器。有37 listed here ;我会大声喊出 this online validator也支持 YAML 模式。

但是，当我说 Swagger 依赖于 JSON API 的一个子集时，我撒了谎。在 Swagger 中有一些具有特殊含义的固定字段不属于 JSON Schema。其中之一是用于多态的discriminator。 我不知道可以处理 discriminator 的 Swagger 验证器。有一个fair number of tools对于 swagger 和一些声称进行验证，但许多是废弃软件，用于旧版本，功能不完整，与其他技术相关，等等。如果我缺少一个成熟且维护良好的库，我很想知道。