Pertanyaan Bagaimana mengelola beberapa file skema JSON?


Saya mencoba memvalidasi JSON API saya menggunakan node.js + json-schema.js dari commonjs-utils. Hanya validasi tunggal yang mudah tetapi tidak dapat menemukan cara yang tepat untuk mengelola beberapa file skema untuk mengaktifkan referensi satu sama lain.

Misalkan saya punya dua Model & dua 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" } }
  }
}  

Setiap skema harus dibagi dalam file terpisah dan online? Atau bisakah saya gabungkan menjadi file skema tunggal seperti di bawah ini? Jika mungkin, bagaimana saya bisa mereferensikan skema lokal?

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

32
2017-11-18 07:31


asal


Jawaban:


Di JSON Schemas, Anda dapat menempatkan skema per file dan kemudian mengaksesnya menggunakan URL mereka (tempat Anda menyimpannya), atau skema besar dengan id tag.

Ini untuk satu file besar:

{
    "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"
        }
    }
}

Anda kemudian dapat mereferensikan validator Anda ke salah satu skema sub (yang didefinisikan dengan id).

Dari luar skema Anda, ini:

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

setara dengan ini:

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

... yang setara, dari dalam, hingga ini:

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

atau ini (masih dari dalam):

{ "$ref": "#book" }

Lihat saya jawab di sini untuk informasi lebih lanjut.


46
2018-01-31 17:12