Schema 数据约束可运行案例
仓库信息:检查 repositoryId 必须存在
本例只要求 repositoryId 存在且为字符串。required 不自动禁止空字符串;需要非空编号时应另外增加 minLength。缺失字段的名称可在 params.missingProperty 中查看。
试一试
在完整工具中打开 ↗示例工作台
Schema 数据约束修改下方数据后重新运行
运行结果
{
"valid": true,
"errors": []
}原例已核验,可修改输入后重新运行。
⌘ / Ctrl + Enter 运行01
场景与操作说明
仓库显示名不一定唯一,应使用稳定标识关联。private 与 visibility 的一致性属于业务规则,本例结构校验不能自动替代权限检查。
stars 为合成计数,不代表任何真实代码仓库的热度。
- 核对 仓库信息 的字段层级,保留 repositoryId 的字符串类型。
- 修改一项输入并运行,观察结果中的值或路径如何变化。
- 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02
对照样本
对照样本故意违反 required。这是已完成的校验,预期 valid 为 false;核对 errors 的 keyword、instancePath 和 params。
查看对照输入
{
"name": "demo-api",
"stars": 3,
"private": true,
"visibility": "internal",
"git": {
"defaultBranch": "main",
"branches": [
"main",
"dev"
]
}
}对照样本的实际结果
{
"valid": false,
"errors": [
{
"instancePath": "",
"schemaPath": "#/required",
"keyword": "required",
"params": {
"missingProperty": "repositoryId"
},
"message": "must have required property 'repositoryId'"
}
]
}