利用JSON Schema校验JSON数据格式

最新推荐文章于 2024-10-12 01:36:34 发布
最新推荐文章于 2024-10-12 01:36:34 发布
阅读量560 收藏 1
点赞数
原文链接：http://www.cnblogs.com/songzhenhua/p/10353281.html
版权

最近笔者在工作中需要监控一批http接口，并对返回的JSON数据进行校验。正好之前在某前端大神的分享中得知这个神器的存在，调研一番之后应用在该项目中，并取得了不错的效果，特地在此分享给各位读者。

什么是JSON Schema?

       JSON Schema是一组特殊的JSON词汇，用来标记和校验JSON数据，也可以理解为一种的对JSON数据格式定义的约定。截至本文撰写时间，该约定的草案已经演进至第7版(draft-07)。JSON Schema使用一种人机都容易理解的方式来描述已有的数据格式。可用于客户端校验用户提交，或者自动化测试中校验结果。

如何获取JSON Schema?

       JSON Schema在各常用语言下基本都有实现，包括：C/C++, Java, JavaScript, PHP, Python, Scala, Go等，不同语言的实现对约定草案的支持程度不尽相同，单就笔者在自动化测试中进行接口返回格式校验的需求来说均可满足。

       各位读者可以在官网链接中获取JSON Schema在不同语言中的实现，请按需取用~

JSON Schema的用法

用过JSON的同学都知道，JSON是构建在以下几种数据结构上的：

1.object:

       {"name": "picotaro", "age": 38}

2.array:

       ["apple", "pen", "pineapple"]

3.number:

       10086

        3.1415926

 4.string:

        "pen pinapple apple pen"

5.boolean:

        true

        false

6.null:

        null

通过上述这六种数据格式，我们可以自由组合出复杂的JSON数据，比如：

       上面两个都是有效的JSON数据，那么当我们需要对接口返回进行校验时，我们该怎么做呢？一般的探活监控可以通过http码或者错误码来进行识别结果是否正确，但如果我们需要精准校验json数据的格式呢？难道我们要写一套复杂的通用逻辑来处理么？不，这个时候我们用JSON Schema就可以啦(众人：少废话，show me the code)。

       假设我们需要接口的回显为第一种格式的数据，那么我们可以定义如下的JSON Schema来描述接口：

       你可能已经注意到JSON Schema本身就是一个JSON数据，因为其本身就是一段数据而非程序，只是一种"描述其他数据的结构"的描述性格式而已，然后校验器会根据这个schema来判断数据是否满足要求。就目前情况来说，第一种会通过，而第二种就会失败。就这样，我们通过利用一些简单的、配置式的定义来完成复杂JSON数据的校验工作。

以下是上面出现过的配置项的含义：

  1.type: 规定值的类型

  2.required: 规定object下哪些键是必须的

  3.properties: 规定object下键的格式

  4.const: @since draft-07，常量，值必须等于该常量

  5.enum: 枚举值，即值只能是enum数组中的某一项

  6.maxLength: 规定字符串的最大长度

  7.maximum: 规定数字的最大值

  8.minimum: 规定数字的最小值

  9.minItems: 规定数组元素的最少个数

       怎么样，是不是觉得非常简单？下一节是可用的配置项信息，可以结合自己的实际需要来编写配置。

配置项

       因最新草案(draft-07)的支持尚不够广泛，本文的配置项以旧版(draft-04)为准。

通用配置

 1.type: string/array, 规定值的类型只能从6个基础类型中选择:number/integer, string, object, array, boolean, null

  2.enum: array, 规定值必须等于该枚举数组中的某一项

number/integer

number和integer作为共享关键字，不得同时出现。两者分别表示数字和整形

  1.multipleOf: number, 规定值必须为该项的倍数

  2.maximum: number, 规定值必须小于等于该项

  3.exclusiveMaximum: boolean, 如果出现该项且不为false，那么值就必须小于maximum

  4.minimum: number, 规定值必须大于等于该项

  5.exclusiveMinimum: boolean, 如果出现该项且不为false，那么值就必须大于minimum

string

  1.maxLength: integer, 规定值的长度必须小于等于该项

  2.minLength: integer, 规定值的长度必须大于等于该项

  3.pattern: string, 正则表达式，规定值必须匹配该项

object

  1.maxProperties: integer, 规定值所包含的键值个数必须小于等于该项

  2.minProperties: integer, 规定值所包含的键值个数必须大于等于该项

  3.required: array, 规定哪些键必须出现

  4.properties: object, 该项的键为值中可能出现的键，该项的值为有效的schema数据。参考上一节的例子

  5.patternProperties: object, 该项的键为正则表达式，用以匹配可能出现键，该项的值为有效的schema数据

Example:

  6.additionalProperties: boolean/object, 该项比较复杂

   6.1.如果出现该项且为false,那么当对象所有的键经过properties和patternProperties匹配后仍有剩余的，即出错

     6.2.如果该项为object,那么其中定义了经过properties和patternProperties匹配后剩余的键的特性

Example:

  7.dependencies: object, 如果出现了某个键则其依赖的键也必须出现

     7.1.属性依赖， 则dependencies中每个键的值为array，数组的元素该键的依赖

Example:

      7.2.schema依赖，则dependencies中每个键的值为object，该对象中通过properties指定其依赖的键

Example:

array

 1.items: 规定每个元素的特性

     1.1.object, 一个有效的schema，对所有数据的元素应用该校验方式

Example:

     1.2.array,每个元素均为一个有效的schema，用一一对应的方式对数组中的元素进行校验

Example:

 2.additionalItems: boolean, 如果出现该项且为false，那么items中值为array的情况下，对应数据中不可出现额外的项

Example:

 3.maxItems: integer, 规定元素个数必须小于等于该项

 4.minItems: integer，规定元素个数必须大于等于该项

 5.uniqueItems: boolean, 如果出现该项且为true，那么数组中的每个元素都不能相同

boolean

无单独配置项

null

无单独配置项

小结

       有了JSON Schema这个神器，接口测试的数据校验变得简单了不少，作为接口监控脚本的一部分，也很容易知道结果中哪部分出了问题。实在是居家旅行、测试开发，必备良药。

 

转自：https://mp.weixin.qq.com/s/iWAyKpdbN3pVwKKJDyGstA

转载于:https://www.cnblogs.com/songzhenhua/p/10353281.html

weixin_30339969
关注
JSON Schema数据校验入门
dosthing的博客
08-07 2014
快速开始 我们用一个例子来介绍说明 JSON Schema，虽然不可能面面俱到，但是对JSON Schema的基本概念、语法、使用有个较为全面的了解是完全没问题的。 这里假设我们有一个产品类目接口是用JSON Data格式来交互的，这个类目的产品信息字段有： 产品ID：productId 产品的名称：productName 产品的销售价格：price 可选字段的产品标签：tags 产品类目数据简单例子： { "productId": 1, "produ..
如何利用JSON Schema校验JSON数据格式
ceba20200309的博客
08-12 732
如何利用JSON Schema校验JSON数据格式
json schema校验
weixin_34326429的博客
08-15 144
工作中使用到了json schema格式校验的问题，在网上查了些资料，结合自己的理解记录一下。 json schema可以对json结果字符串做出一些约束，例如： 1. 值类型是：array, object, number, string等等 2.值类型必须是枚举中的一个 3. 字符串的长度限制 4. 对字符串判断是否符合正则表达式 5. array元素个数 6. object对象必...
C++中的JSON数据处理与cppjson库应用
weixin_29025501的博客
09-09 969
本文还有配套的精品资源，点击获取 简介：本简介关注一个专门针对C++语言的JSON处理库——cppjson。JSON作为一种轻量级的数据交换格式，在Web服务和应用程序中广泛使用。cppjson库提供了方便的API来解析、生成和操作JSON数据，支持开发者将JSON字符串转换为C++对象，或将C++对象序列化为JSON格式。学习如何使用cppjson，包括其API的使用、错...
JSON Schema校验数据
qq_41902662的博客
03-31 5376
JSON Schema
Spring Boot 中使用 JSON Schema 来校验复杂 JSON 数据
最新发布
2301_76419561的博客
10-12 1032
JSON Schema 是一种基于 JSON 的声明性规范，用于描述 JSON 数据的结构。它允许开发者定义 JSON 数据的类型、格式、必填字段、约束条件等。通过使用 JSON Schema，我们可以确保接收到的 JSON 数据符合预期的结构和格式，从而提高数据的质量和可靠性。接下来，我们需要定义一个 JSON Schema 文件来描述我们期望的 JSON 数据结构。},},在这个示例中，我们定义了一个包含username和password字段的 JSON 对象，并设置了相应的类型和约束条件。
Spring Boot 中使用 JSON Schema 来校验复杂JSON数据
程序猿DD
08-06 1054
JSON是我们编写API时候用于数据传递的常用格式，那么你是否知道JSON Schema呢？在数据交换领域，JSON Schema 以其强大的标准化能力，为定义和规范 JSON 数据的结构与规则提供了有力支持。通过一系列精心设计的关键字，JSON Schema 能够详尽地描述数据的各项属性。然而，仅凭 JSON Schema 本身，尚不足以验证 JSON 实例是否严格遵循预设的模式。此时，JSON...
JSON Schema 校验库——json-schema-validator（java版本）.rar
09-16
它提供了一种验证JSON数据是否符合预定义规则的方法，这对于API开发、数据交换和JSON数据存储非常有用。在Java环境中，`json-schema-validator`库是一个强大的工具，用于根据JSON Schema进行数据验证。 `json-...
flask-json-schema:Flask扩展使用jsonschema规范来验证JSON请求
05-08
通过此扩展，可以轻松验证使用jsonschema规范发送到Flask应用的JSON数据 设置 Flask-json-schema在PyPI上可用，并且可以与 pip install flask-json-schema 扩展名可以直接初始化： from flask import Flask from ...
Newtonsoft.Json.Schema：Json.NET Schema是一个功能强大，完整且易于使用的JSON Schema框架。
02-03
在实际开发中，例如在构建RESTful API时，使用Json.NET Schema可以确保客户端发送的请求数据格式正确，避免因数据格式问题引发的错误。同时，在存储和传输数据时，通过JSON Schema验证，可以有效防止恶意数据注入，...
Java bean转换为Json Schema
01-19
在Java中，将Bean转换为Json Schema可以帮助我们在服务器端验证客户端发送的数据是否符合预设的模式，避免因数据格式错误导致的问题。这种转换通常通过一些库或工具来实现，例如`json-schema-generator`或`org.json...
JSON数据格式检验
11-28
JSON数据格式检验，JSON数据类型检验，JSON数据检验，用于校验两个JSON字符串是否一样，包括数据格式一样，数据类型一样，数据值一样
JSON Schema验证规范-中文版
01-25
本文为中文翻译版，原文地址：http://json-schema.org/latest/json-schema-validation.html。JSON Schema（application / schema + json）有几个目的，其中一个是JSON实例验证。本文档为JSON Schema指定了一个词汇表，用于描述JSON文档的含义，为使用JSON数据的用户界面提供提示，以及对有效文档的schema进行验证。
php使用json-schema模块实现json校验示例
01-02
本文实例讲述了php使用json-schema模块实现json校验。分享给大家供大家参考，具体如下： 客户端和服务端的http信息传递，采用json几乎成了标配。json格式简单，易于处理，不过由于没有格式规定，无法校验。 好在php有json-schema模块，可以用来验证json是否符合规定的格式。 安装使用composer composer require justinrainbow/json-schema:~1.3 新建一个schema文件，如：schema.json { type: object, properties: { firstName:
java 通过Json -schema完成对数据的效验
weixin_52457750的博客
07-14 2795
Json -schema java数据效验
使用JSON Schema验证JSON数据
zeroneqin的博客
11-24 1737
JSON Schema 开发中经常需要验证JSON数据，比如从WSAPI返回的JSON数据是否符合预期，很多时候我们会自己写JSON解析和验证代码，其实有一个更简单的办法就是 使用JSON Schema, JSON Schema功能上与XML Schema类似，都是用来验证指定格式的数据，目前还是一个草案，最新的版本是v4，目前已经有许多工具支持JSON Schema来验证数据，如： json
JSON格式校验
Cinderellahh92的博客
03-18 4057
if (isNaN(Number(value))) { try { JSON.parse(value) callback() } catch (e) { callback(new Error('params is not JSON')) } } callback(new Error('params is not JSON')) }
JSON Schema验证json数据
05-10
是的，JSON Schema是用于验证JSON数据的一种语言。它定义了一个JSON文档的结构、数据类型和值的限制，可以用来确保JSON数据符合预期的格式和内容。 JSON Schema定义了一组规则，描述了JSON对象的结构和属性。这些规则可以被用来验证一个JSON对象是否符合JSON Schema的定义。例如，可以使用JSON Schema来确保一个JSON对象有一个特定的属性，或者一个属性的值是特定的类型或格式。 JSON Schema是一个开放的标准，并且有很多不同的实现和工具可以用来验证JSON数据。在使用JSON Schema验证JSON数据时，可以使用类似于以下的代码来实现： ```python import jsonschema # 定义JSON Schema schema = { "type": "object", "properties": { "name": {"type": "string"}, "age": {"type": "number"} }, "required": ["name", "age"] } # 定义要验证的JSON数据 data = { "name": "John", "age": 30 } # 验证JSON数据是否符合JSON Schema的定义 jsonschema.validate(data, schema) ``` 在上面的代码中，我们定义了一个JSON Schema，它要求JSON对象必须有一个名为"name"的字符串属性和一个名为"age"的数字属性。然后我们定义了一个要验证的JSON数据，并使用`jsonschema.validate()`方法来验证它是否符合JSON Schema的定义。如果验证失败，将会抛出异常。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值