Как управлять несколькими файлами схемы JSON? - PullRequest
Новая
       12

Как управлять несколькими файлами схемы JSON?

33 голосов
/ 18 ноября 2011

Я пытаюсь проверить мой JSON API, используя node.js + json-schema.js из commonjs-utils. Простая проверка была простой, но не могла найти правильный способ управления несколькими файлами схемы, чтобы можно было ссылаться друг на друга.

Предположим, что у меня есть две модели и два 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" } }
  }
}

Каждая схема должна быть разделена на отдельный файл и находиться в сети? Или я могу объединить в один файл схемы, как показано ниже? Если это возможно, как я могу ссылаться на локальную схему? 

// single schema file {
    "book": { ... },
    "author": { ... },
    "authors": { ... },
    "books": { ... } }

1 Ответ

49 голосов
/ 31 января 2012

В схемах JSON вы можете либо поместить схему для каждого файла, а затем получить к ним доступ, используя их URL (там, где вы их сохранили), либо большую схему с тегами id.

Вот один большойfile: 

{
    "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).

Снаружи вашей схемы это: 

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

эквивалентно этому: 

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

… что эквивалентно изнутри этому: 

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

или этому (еще изнутри): 

{ "$ref": "#book" }

См. Мой ответ здесь для получения дополнительной информации.

...