当前位置: 首页 > 面试题库 >

根据Swagger API模式验证JSON

时浩波
2023-03-14
问题内容

我从一些JSON文件创建了API规范,并且尝试测试这些文件是否根据API规范进行了验证。

有一些不错的工具可以根据JSON
Schema进行验证,但是我没有找到针对Swagger中创建的规范进行验证的工具(用于创建API架构的工具)。我发现的唯一解决方案是在Swagger-
Editor中生成客户端/服务器,这非常麻烦。

是否已经有现有工具可以针对Swagger Schema验证JSON?


问题答案:

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

您是否要验证您的规格是有效的OpenAPI(fka.Swagger)规格

您可以

  • 将您的规范复制到在线Swagger编辑器中,它将引发错误。快速浏览源代码并不能告诉我它是用来创建那些错误的,但是它似乎并没有联系服务器来实现。
  • 使用Java 的官方swagger-parser。
  • 将非官方的swagger-parser用于JavaScript(浏览器或Node)。

或验证此规范的实现会产生与您的JSON模式有关的JSON?

换句话说,这是来自请求或响应正文的一些JSON,对吗?

Swagger的架构对象依赖于另一个称为JSON
Schema的标准,它实际上是对JSON(而不是端点或元数据)的描述。Swagger使用JSON模式的子集(缺少:oneOf,,patternProperties等等)。为此,您可以使用JSON模式验证器。这里列出了37个 ;
我将向此在线验证器大喊大叫,该验证器还支持YAML模式。

但是,当我说Swagger依赖于JSON API的子集时,我撒了谎。Swagger中有一些固定字段具有特殊含义,这些字段不是JSON
Schema的一部分。其中之一discriminator是用于多态性。
我不知道可以处理的Swagger验证程序discriminator。有很多工具可以摇摇欲坠,有些声称可以进行验证,但是许多工具都是废弃软件,用于旧版本,功能不完整,与其他技术捆绑在一起,依此类推。如果我缺少一个成熟且维护良好的库,我很想知道。



 类似资料:
  • 问题内容: 有没有一种方法可以针对该结构的JSON模式验证JSON结构?我已经查看并发现JSON.Net验证了,但这并不能满足我的要求。 JSON.net可以: 这证明是正确的。 这也证明是真的 仅此验证为假。 理想情况下,我希望它可以验证那里也没有应该存在的字段。 问题答案: 我认为您只需要添加 到您的架构。这将停止提供未知属性。 因此,现在您的结果将是:-正确,错误,错误 测试代码… 输出:-

  • 我从一些JSON文件中创建了一个API规范,并尝试测试这些文件是否符合API规范。 有一些很好的工具可以验证JSON模式,但是我没有机会找到一个工具来验证在Swagger(创建API模式的工具)中创建的规范。我找到的唯一解决方案是在Swagger-Editor中生成客户端/服务器,这很麻烦。 是否已经有一个现有工具可以根据Swagger模式验证JSON?

  • 这是要根据模式验证的JSON。 问题是,如果我们传递了错误的数据,它将正确地验证eid和ename的类型(即整数或字符串)。对于例如: 如果我们为限定传递了错误的类型,那么它将验证为true(即,它不验证限定的类型,可能是因为它是嵌套的)。

  • 据我所知,有一些方法可以根据RDF模式验证序列化的RDF(例如RDF/XML)(如何用您的RDF模式验证RDF)。还有,从RDF/XML到JSON-LD序列化格式的各种转换器(反之亦然)。在Internet上搜索,我找不到一种直接的方法来验证JSON-LD与某种JSON模式的关系,就像RDF模式与RDF(/XML)的关系一样。当然,有各种各样的JSON-LD文档表单,所以我假设一个模式不能很容易地

  • 问题: 有没有一种普通的或本机的javascript方法来根据JSON模式验证JSON脚本? 我在Github上找到了很多库,但没有原生/普通的解决方案。EcmaScript没有对此的规范吗?没有浏览器(或nodejs)有办法原生验证JSON吗? 问题的背景: 我有一个非常复杂的模式,我开发了一个。它应该与一个脚本一起工作,该脚本要求传入其中的 JSON 数据符合架构。

  • 我想使用Jackson库(https://github.com/fasterxml/Jackson)处理Java中的JSON文件,这些文件由一个JSON模式文件描述。 现在,我想验证一个解析的JSON是否符合一个JSON模式文件,该文件是自己解析的。 Jackson有一个JSON模式模块(https://github.com/fasterxml/jackson-module-jsonschema)