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

相关推荐
小葱炖豆腐8 小时前
python绘制excel折线图
python·excel·numpy·pandas·matplotlib
小小测试开发8 小时前
LLM 结构化输出测试:Schema 契约 + 故障注入,让工具调用的 JSON 不再靠重试赌运气
人工智能·json
Ticnix8 小时前
MCP 实战:把工具层从 Agent 里彻底解耦
python·mcp
XZ-0700019 小时前
week4-1-figure画布
python
hasty10 小时前
_proto__ 不是普通键:从 JSON 反序列化看原型污染
安全·json
步行cgn10 小时前
Spring 注入 Map 集合详解
数据库·python·spring
今儿敲了吗10 小时前
03停用词过滤
笔记·python
李可以量化11 小时前
Tornado 部署公域网络安全与防护(上)
python
风跟我说过她11 小时前
SQL 一键转经典 Chen 风格 ER 图:开源 CLI + 在线工具 + Agent Skill
数据库·python·sql·开源·开源软件
Ulyanov11 小时前
AudioVision Pro:基于 PySide6 + sounddevice 的实时音频可视化播放器设计
python·算法·音视频