$ref 不适用于数组类型 json 模式

Question

我有三个 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's.

指向的模式进行验证

我想知道如何使用数组类型模式定义中的 $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);
}

Answer 1

我确定问题出在 $id 更改了 $ref 的分辨率范围。我猜 $ref 分辨率是通过在文件系统上查找文件来实现的。假设您的三个模式在 file:///path/to/schema.

可用

您开始处理 file:///path/to/schema/client.json 架构。
您遇到了引用 contact.json。这是相对URI，所以你需要确定它是相对的URI才能解析它。
您回溯架构，找到最近的 $id，值为 client.json。
这是一个相对 URI，不再有 $id，因此使用文件路径 file:///path/to/schema/client.json。
你现在可以解决 client.json 反对 file:///path/to/schema/client.json 并得到 file:///path/to/schema/client.json.
你现在可以解决 contact.json 反对 file:///path/to/schema/client.json 并得到 file://path/to/schema/contact.json.

这里开始变得奇怪了。

您检索了 file:///path/to/schema/contact.json 架构。
您遇到了引用 address.json。这是一个相对URI，所以你需要确定它是相对的URI才能解析它。
您回溯架构，找到最近的 $id，值为 /items。
这是一个相对URI，所以你一直回溯找到contact.json。
这是一个相对 URI，不再有 $id，因此使用文件路径 file:///path/to/schema/contact.json。
现在你可以解决 /items 反对 file:///path/to/schema/contact.json 并得到 file:///items.
现在你可以解决 address.json 反对 file:///items 并得到 file:///address.json.
您尝试检索 file:///address.json 架构，但它不存在。

因为 $id 更改了 $ref 的解析范围，所以强烈建议不要像您在模式中所做的那样为所有内容提供 $id。此功能适用于将多个小模式组合成一个这样的用例。除了在文档的根目录之外，你真的不应该使用它，除非你有充分的理由并理解其中的含义。

$ref 不适用于数组类型 json 模式

$ref not working from array type json schema

schema

json

jsonschema

ajv