如何在JSON模式中扩展模式？

Question

我对文档模式的定义如下：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "http://example.com/schemas/document.json#",
  "title": "Document",
  "type": "object",
  "additionalProperties": false,
  "required": ["type", "name", "fields"],
  "properties": {
    "type": {
      "constant": "document"
    },
    "name": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "readOnly": {
      "type": "boolean"
    },
    "properties": {
      // common properties 
      // model-specific properties
    }
  }
}

Answer 1

当使用NodeJs时，通过使用ajv验证器的少量代码，很容易绕过简单模式的限制，如下所示：

function extendJsonSchema(baseSchema, extendingSchema) {
    let extendedSchema = Object.assign({}, extendingSchema);
    extendedSchema.properties = Object.assign(extendedSchema.properties, baseSchema.properties)
    extendedSchema.required = extendedSchema.required.concat(baseSchema.required)
    return extendedSchema
}


let baseSchema = require('./base.schema.json')
let extendingSchema = require('./extending.schema.json')

let extendedSchema = extendJsonSchema(baseSchema, extendingSchema)
const validate = ajv.compile(extendedSchema)

这至少解决了我的用例。

Answer 2

因此，您可以使用组合来“扩展”一个模式，但是您永远不能“覆盖”另一个模式定义的内容。

让我们来看一个没有冲突属性的简单扩展示例。

/schema/base

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  }
}

/schema/扩展

{
  "allOf": [{ "$ref": "/schema/base" }],
  "properties": {
    "baz": { "type": "string" }
  }
}

这对JSON模式非常有用。现在让我们来看一个属性定义冲突的示例。

/模式/覆盖

{
  "allOf": [{ "$ref": "/schema/base" }],
  "properties": {
    "bar": { "type": "integer" },
    "baz": { "type": "boolean" }
  }
}

在本例中，两个模式都有一个< code>/properties/bar字段。如果你从继承的角度考虑这个问题，你会误解这里发生的事情。在这种情况下，两个“/属性/栏”字段都必须有效。没有要解决的冲突。正如关键字所说，“所有”模式都必须有效。因为< code>bar不可能既是整数又是字符串，所以没有文档会根据< code>/schema/override进行验证。

希望这能给你足够的信息来解决你的问题，避免最常见的问题。