如何根据已记录字段起草 JSON Schema
JSON Schema 草稿明确数据的预期结构。当文档描述了字段,但需要机器可读的验证起点时,它很有用。
从合适的材料开始。
- 你需要提供什么
- 可见的 API 响应规范。
- 预期结果
- 创建 JSON Schema 草稿,保留文档注明的必填字段并标记假设。
工作流程如何运作。
将已记录字段映射到类型和要求,并清楚表示嵌套对象与数组。来源未说明格式、约束或模式方言时,标明相关假设。
结果中需要检查的内容。
验证模式,并尝试已知有效和无效的示例。不要仅为得到整齐的模式,就把所有已记录字段设为必填或编造限制性规则。
在其他应用中使用前先解析 JSON,再检查其中的实际值。语法有效只表明解析器能读取结构,并不能证明提取出的事实正确。
参考完整示例学习。
可下载的示例是 JSON 对象。将其结构和缺失值处理方式与你需要的结果比较,再对照提供的来源核查自己的值。
所提供的示例仅用于说明,并非针对你的数据执行的记录。
下载示例 ↓用于你自己的材料。
- 打开要处理的来源,并在该标签页中启用 WebAct。
- 复制页面顶部的任务,补充必需的字段或偏好,并检查建议执行的操作。
- 将首次结果与来源对照,必要时提出具体修改或完善要求。