如何在JSON模式验证器中表示联合类型？

Question

type Conf = {
idle_session_timeout?: number | "none",
item: {
    kind: "attribute";
    name: string;
} | {
    kind: "relation";
    name: string;
} | {
    kind: "group";
    name: string;
    label?: string | undefined;
    entries: PresentationItem[];
}
 order_by: string | {
    attribute: string;
    direction?: "asc" | "desc" | undefined;
}
}

我从http://json-schema.org/draft-07/schema中注意到，它支持if then else语句根据值切换验证模式，但我不知道如何实现它们。

Answer 1

您需要注意以下几个关键字，并可能参考以下规范：

首先，“type”允许在一个数组中指定多个值。这样，您可以指定[“string”,“number”]表示“string或number”。许多关键字仅在实例为特定JSON类型时应用。通常，您可以将一个“类型”模式和另一个不同的“类型”模式组合在一起，如果所有剩余的关键字仅适用于相应的类型。

因此，作为一个示例，您可以有两个模式，如下所示：

{
  "type": "string",
  "minLength": 1
}
{
  "type": "number",
  "minimum": 0
}

{
  "type": ["string", "number"],
  "minLength": 1
  "minimum": 0
}

{
"type": "object",
"properties": {
  "idle_session_timeout": {
    "type": ["number","string"],
    "anyOf": [ {"type":"number"}, {"const":"none"} ]
  },
  "item": {
    "type": "object",
    "required": ["kind", "name"],
    "properties": {
      "kind": { "type": "string" },
      "name": { "type": "string" },
    },
    "anyOf": [
      {
        "properties": {
          "kind": { "const": "attribute" },
        }
      },
      {
        "properties": {
          "kind": { "const": "relation" },
        }
      },
      {
        "required": ["entries"],
        "properties": {
          "kind": { "const": "group" },
          "label": { "type": "string" },
          "entries": { "type":"array", "items": {"$ref":"PresentationItem"} },
        }
      }
    ]
  },
  "order_by": {
    "type": ["string", "object"],
    "required": ["attribute"],
    "properties": {
      "attribute": { "type": "string" },
      "direction": { "enum": ["asc", "desc"] },
    }
  }
}