Pregunta ¿Cómo administrar múltiples archivos de esquema JSON?


Estoy intentando validar mi API JSON utilizando node.js + json-schema.js de commonjs-utils. La validación única fue fácil, pero no se pudo encontrar la forma correcta de administrar los archivos de esquemas múltiples para permitir la referencia entre sí.

Supongamos que tengo dos modelos y dos 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" } }
  }
}  

¿Cada esquema debe dividirse en un archivo separado y estar en línea? ¿O puedo combinar en un solo archivo de esquema como a continuación? Si es posible, ¿cómo puedo hacer referencia al esquema local?

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

32
2017-11-18 07:31


origen


Respuestas:


En los Esquemas JSON, puede colocar un esquema por archivo y luego acceder a ellos utilizando su URL (donde los almacenó), o un gran esquema con id etiquetas.

Aquí hay un gran archivo:

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

A continuación, puede hacer referencia a su validador a uno de esos subesquemas (que se definen con un id)

Desde fuera de tu esquema, esto:

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

es equivalente a esto:

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

... que es equivalente, desde adentro, a esto:

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

o esto (todavía desde adentro):

{ "$ref": "#book" }

Mira mi responde aquí para más información.


46
2018-01-31 17:12