$ ref无法使用数组类型的json模式

时间:2018-03-25 06:23:36

标签: json schema jsonschema ajv

我有三个json-schema定义。 客户,地址和联系方式。

client.json

{
  "$id": "client.json",
  "type": "object",
  "definitions": {},
  "$schema": "http://json-schema.org/draft-06/schema#",
  "properties": {
    "name": {
      "$id": "/properties/name",
      "type": "string"
    },
    "id": {
      "$id": "/properties/id",
      "type": "integer"
    },
    "contact": {
            "$ref": "contact.json"
    },
    "address": {
        "$ref": "address.json"
    }
  }
}

address.json

{
  "$id": "address.json",
  "type": "array",
  "definitions": {},
  "$schema": "http://json-schema.org/draft-06/schema#",
  "items": {
    "$id": "/items",
    "type": "object",
    "properties": {
      "addressId": {
        "$id": "/items/properties/addressId",
        "type": "integer"
      },
      "addressName": {
        "$id": "/items/properties/addressName",
        "type": "string"
      }
    }
  }
}

contact.json

{
  "$id": "contact.json",
  "type": "array",
  "definitions": {},
  "$schema": "http://json-schema.org/draft-06/schema#",
  "items": {
    "$id": "/items",
    "type": "object",
    "properties": {
      "contactId": {
        "$id": "/items/properties/contactId",
        "type": "integer"
      },
      "contactName": {
        "$id": "/items/properties/contactName",
        "type": "string"
      },
      "address": {
          "$ref": "address.json"
      }
    }
  }
}

对象待验证

var client = {
    "name": "test",
    "id": 12,
    "contact": [
        {
        "contactId": 12212,
        "contactName": "jon",
        "address": [
            {
                "addressId": 64,
                "addressName": "pi"
            }
        ]
    }
    ],
    "address": [
        {"addressId": 4242,
        "addressName": "doe"}
    ]
};

来自'client.json'的$ ref工作正常,但我从'contact.json'引用'address.json'时出错。 我在'additionalItems'中使用$ refs时没有错误,但无法验证$ ref的指向模式。

我想知道如何从数组类型模式定义中使用$ ref。 另外,我正在使用AJV进行模式验证。

编辑1: AJV设置

var Ajv = require('ajv');
var ajv = new Ajv({
    $data: true,
    allErrors: true,
    useDefaults: true, 
    coerceTypes: true, 
});

ajv.addSchema(client);
ajv.addSchema(contact);
ajv.addSchema(address);

let valid = ajv.validate('client.json', payload);

if(!valid){
    console.log(ajv.errors);
}

1 个答案:

答案 0 :(得分:0)

我确定问题是/play更改了$id的解析范围。我通过查找文件系统上的文件来猜测$ref分辨率正在发生。我们假设你的三个模式可以在$ref获得。

  1. 您开始处理file:///path/to/schema架构。
  2. 您遇到参考file:///path/to/schema/client.json。这是相对URI,因此您需要确定它相对于的URI才能解决它。
  3. 您回溯了架构,找到了值contact.json的最近的$id
  4. 这是一个相对URI,不再有client.json个,因此使用了文件的路径$id
  5. 您现在可以针对file:///path/to/schema/client.json解决client.json并获取file:///path/to/schema/client.json
  6. 您现在可以针对file:///path/to/schema/client.json解决contact.json并获取file:///path/to/schema/client.json
  7. 这里开始变得奇怪。

    1. 您检索file://path/to/schema/contact.json架构。
    2. 您遇到参考file:///path/to/schema/contact.json。这是一个相对URI,因此您需要确定它相对于它的URI才能解决它。
    3. 您回溯了架构,找到了值address.json的最近的$id
    4. 这是一个相对URI,因此您可以继续回溯并找到/items
    5. 这是一个相对URI,不再有contact.json个,因此使用了文件的路径$id
    6. 现在,您可以针对file:///path/to/schema/contact.json解决/items并获取file:///path/to/schema/contact.json
    7. 现在,您可以针对file:///items解决address.json并获取file:///items
    8. 您尝试检索file:///address.json架构,但它不存在。
    9. 由于file:///address.json更改了$id的解析范围,因此非常不鼓励您在模式中提供与$ref类似的内容。此功能适用于将多个小模式合并为一个的用例。除非你有充分的理由并理解其含义,否则你应该永远不要在文档的根部使用它。