web-dev-qa-db-ja.com

複数のJSONスキーマファイルを管理する方法

Commonjs-utilsのnode.js + json-schema.jsを使用してJSON APIを検証しようとしています。単一の検証は簡単でしたが、複数のスキーマファイルを管理して相互参照を可能にする正しい方法を見つけることができませんでした。

2つのモデルと2つのAPIを取得したとします。

// book
{
  "type": "object",
  "properties": {
      "title": { "type": "string" },
      "author": { "type": "string" }
  }
}
// author
{
  "type": "object",
  "properties": {
      "first_name": { "type": "string" },
      "last_name": { "type": "string" }
  }
}  
// authors API
{
  "type": "array",
  "items": { "$ref": "author" }
}
// books API: list of books written by same author
{
  "type": "object",
  "properties": {
    "author": { "$ref": "author" } 
    "books": { "type": "array", "items": { "$ref": "book" } }
  }
}

各スキーマは別々のファイルに分割してオンラインにする必要がありますか？または、以下のように1つのスキーマファイルに結合できますか？可能であれば、ローカルスキーマをどのように参照できますか？

// single schema file {
    "book": { ... },
    "author": { ... },
    "authors": { ... },
    "books": { ... } }
jsonnode.jsschemajsonschema
35
Ray Yun

JSONスキーマでは、ファイルごとにスキーマを配置してから、URL（それらを格納した場所）を使用してそれらにアクセスするか、idタグを使用して大きなスキーマを使用できます。

これは1つの大きなファイルの場合です。

{
    "id": "#root",
    "properties": {
        "author": {
            "id": "#author",
            "properties": {
                "first_name": {
                    "type": "string"
                },
                "last_name": {
                    "type": "string"
                }
            },
            "type": "object"
        },
        // author
        "author_api": {
            "id": "#author_api",
            "items": {
                "$ref": "author"
            },
            "type": "array"
        },
        // authors API
        "book": {
            "id": "#book",
            "properties": {
                "author": {
                    "type": "string"
                },
                "title": {
                    "type": "string"
                }
            },
            "type": "object"
        },
        // books API: list of books written by same author
        "books_api": {
            "id": "#books_api",
            "properties": {
                "author": {
                    "$ref": "author"
                },
                "books": {
                    "items": {
                        "$ref": "book"
                    },
                    "type": "array"
                }
            },
            "type": "object"
        }
    }
}

次に、バリデーターをそれらのサブスキーマ（idで定義されている）の1つに参照できます。

スキーマの外側から、これは：

{ "$ref": "url://to/your/schema#root/properties/book" }

これと同等です：

{ "$ref": "url://to/your/schema#book" }

…これは、内側からこれと同等です。

{ "$ref": "#root/properties/book" }

またはこれ（まだ内側から）：

{ "$ref": "#book" }

詳細はmy answer here を参照してください。

49
Flavien Volken