Schema 数据约束可运行案例
异步任务:拒绝合同以外的额外字段
本例显式声明 taskId、taskName、progress、retryable、state、execution,并用 additionalProperties: false 拒绝同层其他属性。这里只约束当前对象;嵌套 execution 的内部属性需要另写规则。
试一试
在完整工具中打开 ↗示例工作台
Schema 数据约束修改下方数据后重新运行
运行结果
{
"valid": true,
"errors": []
}原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
异步任务接收成功与执行完成是两个状态。本例用于查看和校验任务返回,不进行真实轮询、重试或任务调度。
progress 使用本例 0 到 100 的进度约定;下面通用非负约束不等于完整进度合同。
- 核对 异步任务 的字段层级,保留 taskId 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本故意违反 additionalProperties。这是已完成的校验,预期 valid 为 false;核对 errors 的 keyword、instancePath 和 params。
查看对照输入
{
"taskId": "demo-jobs-1",
"taskName": "演示导出任务",
"progress": 0,
"retryable": true,
"state": "queued",
"execution": {
"worker": "worker-a",
"steps": [
"prepare",
"export"
]
},
"unexpectedDemo": true
}对照样本的实际结果
{
"valid": false,
"errors": [
{
"instancePath": "",
"schemaPath": "#/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "unexpectedDemo"
},
"message": "must NOT have additional properties"
}
]
}