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": {
        "orders": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "orderId": {
                "type": "string"
              },
              "subject": {
                "type": "string"
              },
              "quantity": {
                "type": "integer"
              },
              "paid": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "delivery": {
                "type": "object",
                "properties": {
                  "city": {
                    "type": "string"
                  },
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "sku": {
                          "type": "string"
                        },
                        "count": {
                          "type": "integer"
                        }
                      },
                      "required": [
                        "sku",
                        "count"
                      ]
                    }
                  }
                },
                "required": [
                  "city",
                  "items"
                ]
              }
            },
            "required": [
              "orderId",
              "subject",
              "quantity",
              "paid",
              "status",
              "delivery"
            ]
          }
        },
        "summary": {
          "type": "object",
          "properties": {
            "total": {
              "type": "integer"
            },
            "note": {
              "type": "null"
            }
          },
          "required": [
            "total",
            "note"
          ]
        }
      },
      "required": [
        "orders",
        "summary"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

订单返回中,订单号用于关联记录,数量用于计算,支付标记和流程状态分别表达不同信息。下面使用两条订单及各自的配送明细,练习提取标识、核对数量类型和定位状态变化。

quantity 为本例商品件数;金额应另行约定精度与币种。

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

对照样本

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

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

对照样本的实际结果

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