Schema 数据约束可运行案例
分页搜索:拒绝合同以外的额外字段
本例显式声明 recordId、headline、rank、selected、kind、snippet,并用 additionalProperties: false 拒绝同层其他属性。这里只约束当前对象;嵌套 snippet 的内部属性需要另写规则。
试一试
在完整工具中打开 ↗示例工作台
Schema 数据约束修改下方数据后重新运行
运行结果
{
"valid": true,
"errors": []
}原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
分页返回中的当前页条数、总条数和记录排序有不同用途。本例 summary.total 仅等于这份合成数据的记录数,不能推断真实服务的分页实现。
rank 是本页展示序号,排序变化不应改写 recordId。
- 核对 分页搜索 的字段层级,保留 recordId 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本故意违反 additionalProperties。这是已完成的校验,预期 valid 为 false;核对 errors 的 keyword、instancePath 和 params。
查看对照输入
{
"recordId": "demo-pagination-1",
"headline": "搜索结果甲",
"rank": 1,
"selected": true,
"kind": "document",
"snippet": {
"text": "第一段摘要",
"highlights": [
"字段"
]
},
"unexpectedDemo": true
}对照样本的实际结果
{
"valid": false,
"errors": [
{
"instancePath": "",
"schemaPath": "#/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "unexpectedDemo"
},
"message": "must NOT have additional properties"
}
]
}