Liquid Studio:如何将JSON模式$ ref写入另一个文件

时间:2017-03-24 12:13:46

标签: json liquid-xml

我尝试使用" $ ref"来引用位于不同文件中的JSON模式。使用Liquid Studio 2017.引用的JSON模式和引用的JSON模式都位于同一目录中。

我尝试使用相对路径:

"$ref": "referredSchema.json/propertyName"

并使用绝对路径:

"$ref": "file:///C:/JSON/referredSchema.json/propertyName"
"$ref": "file:///JSON/referredSchema.json/propertyName"
"$ref": "file:///JSON/referredSchema.json#/propertyName"

以及其他一些变化。 他们都没有工作,我总是收到错误消息"无效的URI"。此外,文档仅提及在没有给出合理示例的情况下可以引用其他文档。

所以我想知道,预期的URI格式是什么。

1 个答案:

答案 0 :(得分:5)

您可以使用$ ref属性引用本地文件或外部文件中定义的模式。

你遇到的问题是片段部分(#之后的位)。这引用了根模式上的definitions属性中的模式。

以下示例应说明如何为本地文件和外部文件执行此操作

<强> Main.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "ReferenceToLocalSchema": {
            "$ref": "#/definitions/LocalType"
        },
        "ReferenceToExternalSchema": {
            "$ref": "Common.json#/definitions/ExternalType"
        }
    },
    "definitions": {
        "LocalType": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "no-write": {
                    "type": "boolean",
                    "default": false
                }
            }
        }
    }
}

JSON Schema Diagram

<强> Common.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "additionalProperties": false,
    "definitions": {
        "ExternalType": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "src": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "minLength": 1
                    }
                }
            },
            "required": [
                "src"
            ]
        }
    }
}

JSON Schema Diagram

请注意对本地架构的引用

"$ref": "#/definitions/LocalType"

和远程架构

"$ref": "Common.json#/definitions/ExternalType"

我用相对网址展示了这个,但它可能是一个完全合格的网址

"$ref": "file:///Common.json#/definitions/ExternalType"

有一点需要注意。目前,UI中显示的可能选项列表仅显示本地文件中定义的定义。必须在代码视图中输入对外部文件的引用。

enter image description here

如果您仍有疑问,请在问题中添加架构。