3

我已经阅读了有关 JSON Schema 和 JSON 指针的 RFC，但我仍在努力理解如何正确引用其他文档。

假设我有以下文件（在磁盘上）：

/foo/bar/schema/base.json
/foo/bar/schema/model/model.json

base.json 是这样的：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/schema/base",
  "title": "Base Response",
  "description": "Schema descriptions of common properties of a response",
  "type": [ "object" ],

  "definitions": {
    "data": {
      "descrpition": "The response data is encapsulated within here",
      "example": "true",
      "type": [ "object", "array", "boolean", "null" ]
    }
  },

  "properties": {
    "data": { "$ref" : "#/definitions/data" }
  }
}

model.json 文件是这样的：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/schema/model/model",
  "type": "object",

  "$ref": "/schema/base.json"
}

model.json 中的 $ref 值是我要问的。我对标准的理解是，在文档的id和$ref之间，我们应该可以找到文档。

或者，我想知道是否是这样的：

"$ref": "../../base.json"

会工作？

但是这些解决方案似乎都不能使用我尝试过的 Python 或 PHP 库。我不确定我要去哪里错了？

4

1 回答 1

6

首先，不同的库$ref以不同的方式处理分辨率，因此您需要遵循它们的特定文档来找出确切的细节。$ref但以下是有关分辨率的一些一般信息，您可能会发现这些信息对您有所帮助。

将您的架构文档视为您在浏览器中查看的网页。id代表浏览器 URL 栏中的 URL 。它必须是一个完整的绝对规范化 URL，就像在您的浏览器中一样。

{
  "id": "file:///path/to/project/foo/bar/schema/model/model.json"
}

可以将其想象为$ref您在浏览器中查看的网页中的链接。In 可以是绝对的或相对的，就像在您的浏览器中一样。亲戚$ref将按照与网页上的链接相同的规则进行解析。例如，我希望$ref以下 JSON 中的所有 s 都解析为相同的值。（注意：使用多个是无效的$ref。这只是为了说明。）

{
  "id": "file:///path/to/project/foo/bar/schema/model/model.json",
  "$ref": "file:///path/to/project/foo/bar/schema/base.json",
  "$ref": "/path/to/project/foo/bar/schema/base.json",
  "$ref": "../model.json"
}

如果id不存在，则用于检索模式的 URI 应假定为id. 在这种情况下file:///path/to/project/foo/bar/schema/model/model.json。

这就是它应该从高层次上工作的方式，但是实现方式在实现方式上有所不同。有些要求以特定方式设置库。例如，我使用的 PHP 验证器要求您将所有模式注册到 aSchemaStore中，然后才能引用它们。

参考：http: //json-schema.org/latest/json-schema-core.html#anchor27

于 2015-10-30T22:38:27.657 回答