Schema 数据约束可运行案例
商品目录:拒绝合同以外的额外字段
本例显式声明 sku、title、stock、visible、category、attributes,并用 additionalProperties: false 拒绝同层其他属性。这里只约束当前对象;嵌套 attributes 的内部属性需要另写规则。
试一试
在完整工具中打开 ↗示例工作台
Schema 数据约束修改下方数据后重新运行
运行结果
{
"valid": true,
"errors": []
}原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
商品目录的 SKU 是文本标识,库存为 0 仍是有效商品。属性中的可选尺寸需要保留数组层级,不能将展示顺序误认为标识。
stock 是演示可用库存;实际库存口径需以业务合同为准。
- 核对 商品目录 的字段层级,保留 sku 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本故意违反 additionalProperties。这是已完成的校验,预期 valid 为 false;核对 errors 的 keyword、instancePath 和 params。
查看对照输入
{
"sku": "demo-products-1",
"title": "演示笔记本",
"stock": 30,
"visible": true,
"category": "book",
"attributes": {
"color": "蓝",
"sizes": [
"A5",
"A6"
]
},
"unexpectedDemo": true
}对照样本的实际结果
{
"valid": false,
"errors": [
{
"instancePath": "",
"schemaPath": "#/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "unexpectedDemo"
},
"message": "must NOT have additional properties"
}
]
}