JSON-SCHEMA：获取额外的Properties列表？

Question

是否可以获取 json-schema 找到的所有 additionalProperties 的列表？

例如，如果我的架构如下所示：

{
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
    },
    "lastName": {
      "type": "string",
    },
    "age": {
      "type": "integer"
    }
  }
}

并且数据如下所示：

{
  "firstName": "John",
  "lastName": "Doe",
  "age": 21,
  "extraField": "some new data I was not expecting",
  "anotherExtraField": "another unexpected data point"
}

在这种情况下，我想要一个列表作为返回，而不是由于 additionalProperties: false 而导致 json-schema 异常： [额外字段，另一个额外字段]

Answer 1

如果您使用的是支持带有注释的2019-09或2020-12的实现，那么您很幸运！ 附加Properties应产生其验证属性的注释结果（ spec ）。

如果添加附加Properties：true，则所有额外的属性通过并通过关键字进行验证，这意味着应在注释结果中列出这些额外的属性。

{
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "type": "integer"
    }
  },
  "additionalProperties": true
}

这会产生（在详细输出格式中）

{
  "valid": true,
  "keywordLocation": "#",
  "instanceLocation": "#",
  "annotations": [
    {
      "valid": true,
      "keywordLocation": "#/properties",
      "instanceLocation": "#",
      "annotation": [
        "firstName",
        "lastName",
        "age"
      ]
    },
    {
      "valid": true,
      "keywordLocation": "#/additionalProperties",
      "instanceLocation": "#",
      "annotation": [
        "extraField",
        "anotherExtraField"
      ]
    }
  ]
}

您可以在

如果您不使用.NET，则可以浏览实现页面其他库。其中一些也可能支持注释，但我不确定哪个是。