JSON.CN让代码更轻
JSON 整理与类型生成可运行案例

异步任务:从样本起草 Draft-07 Schema

从 异步任务 的样本推断字段与类型。样本无法证明全部必填项、合法范围和业务状态,发布前应补正常与异常样本,再用 Schema 校验工具核对。

浏览器本地处理合成数据同场景 32 个案例 ↗

示例工作台

在完整工具中打开 ↗
JSON 整理与类型生成修改下方数据后重新运行
运行结果
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "tasks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "taskId": {
                "type": "string"
              },
              "taskName": {
                "type": "string"
              },
              "progress": {
                "type": "integer"
              },
              "retryable": {
                "type": "boolean"
              },
              "state": {
                "type": "string"
              },
              "execution": {
                "type": "object",
                "properties": {
                  "worker": {
                    "type": "string"
                  },
                  "steps": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "worker",
                  "steps"
                ]
              }
            },
            "required": [
              "taskId",
              "taskName",
              "progress",
              "retryable",
              "state",
              "execution"
            ]
          }
        },
        "summary": {
          "type": "object",
          "properties": {
            "total": {
              "type": "integer"
            },
            "note": {
              "type": "null"
            }
          },
          "required": [
            "total",
            "note"
          ]
        }
      },
      "required": [
        "tasks",
        "summary"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}

原例已核验,可修改输入后重新运行。

⌘ / Ctrl + Enter 运行
01

场景与操作说明

异步任务接收成功与执行完成是两个状态。本例用于查看和校验任务返回,不进行真实轮询、重试或任务调度。

progress 使用本例 0 到 100 的进度约定;下面通用非负约束不等于完整进度合同。

  1. 核对 异步任务 的字段层级,保留 taskId 的字符串类型。
  2. 修改一项输入并运行,观察结果中的值或路径如何变化。
  3. 载入对照样本,复现下面的变化;恢复原例会替换当前输入。
02

对照样本

对照样本没有 tasks 元素,无法推断元素结构。比较两份 Schema,确认哪些约束来自样本证据,哪些仍需人工补充。

查看对照输入
{
  "ok": true,
  "data": {
    "tasks": [],
    "summary": {
      "total": 2,
      "note": null
    }
  }
}

对照样本的实际结果

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "tasks": {
          "type": "array",
          "items": {}
        },
        "summary": {
          "type": "object",
          "properties": {
            "total": {
              "type": "integer"
            },
            "note": {
              "type": "null"
            }
          },
          "required": [
            "total",
            "note"
          ]
        }
      },
      "required": [
        "tasks",
        "summary"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}