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 可以定义属性之间的依赖关系;

相关推荐
暗黑小白1 小时前
路由策略与引擎可替换性
后端·python·ai agent
小罗水2 小时前
第 20 章 高级 RAG 技术与检索优化
人工智能·python·机器学习
bamb002 小时前
一个项目带你入门AI应用开发06
python
liwulin05062 小时前
【ESP32S3】调用百度云语音合成接口后重启
python
m沐沐2 小时前
【机器学习】矿物识别系统实战——六种填充方法×六种模型全面对比
人工智能·python·深度学习·机器学习·矿物识别
软糖姐姐2 小时前
Python:__closure__ 详解
python·闭包·__closure__·自由变量·cell对象
月光船幽幽3 小时前
四层公理框架驱动AI健康诊断
人工智能·python·科技·算法·安全
郝学胜-神的一滴3 小时前
力扣 692:巧用小顶堆高效求解前K个高频单词
java·数据结构·python·程序人生·算法·leetcode·职场和发展
栈溢出的浪漫3 小时前
Python单元测试框架覆盖率-Coverage
python·单元测试·工具·覆盖率·coverage
淼澄研学3 小时前
Python构建AI应用:从环境配置到FastAPI部署的5个实操步骤
人工智能·python·fastapi