JSON Schema使用

JSON Schema 是用来定义和 校验 JSON 的Web 规范:用来检验 json 是否符合预期

针对 接口返回值校验时,

1.校验关键字段的值:可能会漏掉一些重要的字段/值

2.json返回值完整校验:如果返回的json 很长,那么就会很麻烦;

接口返回的字段对应的值每次可能是不同的--但同一个接口返回的字段名一定是不变的

校验接口返回值:

1.需要返回的字段是否都存在

2.保证数据的类型是正确的

1.下载 JSON Schema

2.使用 JSOn Schema

手写 json schema 很麻烦,所以可以从下面这个网址里 自动将 json 转换成 json schema

https://tooltt.com/json2schema/

3.JSON Schema数据类型

string---字符串类型,用于文本数据

number---数字类型,用于表示浮点数

integer--整型类型,用于表示整数

boolean---布尔类型,值为 true / false

object---对象类型,用于嵌套的 JSON 对象

array---数组类型,用于列表/集合

null---空值类型

4.最大值最小值

minimum 和 maximim :指定数值的最小值和最大值

exclusiveMinimum 和 exclusiveMaximum :指定数值 必须严格大于 或 小于 某个值

年龄为 : 20,限定年龄最大为 100,最小为 0;

5.字符串特殊校验

pattern:使用正则表达式来验证字符串是否符合特定的模式

例:\S 表示匹配字符

6.数组约束

minItems 和 maxItems :指定数组最小 和 最大长度

uniqueItems:确保数组中的元素是唯一的(默认情况:允许存在重复的数据)

items:定义数组中每个元素的类型和约束

minItems 和 maxItems

uniqueItems

7.对象约束

minProperties 和 maxProperties:指定对象的最小值和最大值数量

additionalProperties:控制是否允许对象中存在 未在 properties 中定义的额外属性,默认为:True;

虽然没有进行校验,但也并没有报错;所以当我们不想出现出现这种情况就可以使用约束

此时添加 additionalProperties 字段,并设置为 False 即可

additionalProperties 添加在哪里,就闲置的是哪个 层级的 字段

8.必须属性

添加必须属性

9.依赖关系

dependtRequired 可以定义属性之间的依赖关系;

相关推荐
凌界天行2 分钟前
知名的无人机侦测肩灯制造厂名声
python
XZ-0700013 分钟前
week10-直方图
python
外收内放5 分钟前
FastAPI猜字谜实战(6):日志与异常
开发语言·python·学习·fastapi
PythonFun6 分钟前
如何生成Python50天系列学习互动网页课件
python·wps
垆边人似月.9 分钟前
预处理与参数调优(让识别率从“能看”到“可用”)
开发语言·python·自然语言处理
gf132111112 分钟前
python_高德地图驾车时长查询
数据库·python·mysql
镜子AI14 分钟前
镜子AI技术实践:用 Python 做 GEO 答案的实体提及抽取与归一化(零依赖两阶段方案)
python·ai
I Am a robert girl17 分钟前
从点到面:Superquadric 分解中“几何感知内点精修”的工程拆解
python·ransac·点云处理·三维感知·superquadric·几何基元拟合·内点判定
计算机毕业编程指导师21 分钟前
计算机毕设推荐:基于深度学习的动物图像识别方法研究(Python+Django+PyTorch)
pytorch·python·深度学习·计算机·毕业设计·课程设计·图像识别
Java后端的Ai之路22 分钟前
【AIAgent项目-AI生成PPT-09】灵活排版
前端·vue.js·人工智能·python·powerpoint