Esquema JSON

Esquema#

Un objeto JSON no incluye ningún contexto ni metadato, y no hay forma de saber solo con mirar el objeto qué significan las propiedades o cuáles son los valores permitidos.

A continuación tienes un objeto que pertenece a un catálogo de productos:

{
    "id": 65,  
    "name": "A green door",  
    "price": 12.50,  
    "tags": [ "home", "green" ]
}

Un esquema es un documento JSON que contiene la descripción y las restricciones que debe tener un documento JSON para cumplir con ese esquema y, por lo tanto, ser una instancia de ese esquema.

Crea un archivo procut.json.

El esquema más básico es un objeto JSON vacío, que no restringe nada, no permite nada y no describe nada:

{}

Al añadir propiedades de validación al esquema, puedes aplicar restricciones a una instancia.

Por ejemplo, puedes usar la propiedad "type" para restringir una instancia a un objeto, array, cadena, número, booleano o null:

{ "type": "string" }

Para crear una definición de esquema básica, define las siguientes propiedades:

• $schema: especifica a qué “draft” del estándar JSON Schema se ajusta el esquema.
• $id: establece una URI para el esquema. Puedes usar esta URI única para referenciar elementos del esquema desde el mismo documento o desde documentos JSON externos.
• title y description: indican la intención del esquema. Estas propiedades no añaden ninguna restricción a los datos que se validan.
• type: define la primera restricción de los datos JSON. En el ejemplo del catálogo de productos siguiente, esta propiedad especifica que los datos deben ser un objeto JSON.

Por ejemplo:

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/product.schema.json",
    "title": "Product",
    "description": "A product in the catalog",
    "type": "object"
}