JSON Schema: Validación y Estructura de Datos JSON – Guía Completa

JSON Schema es una especificación que define la estructura de datos JSON. Actúa como un «contrato» para los datos JSON, describiendo su formato y asegurando la consistencia. Este esquema, escrito en formato JSON, facilita la documentación y la validación, permitiendo tanto a humanos como a máquinas comprender y procesar los datos de forma eficiente.

En este artículo, exploraremos a fondo el mundo de JSON Schema, profundizando en sus características, usos y beneficios. Veremos cómo define la estructura de los datos JSON y cómo se utiliza para validar la información, asegurando que cumple con las reglas establecidas.

¿Qué es JSON Schema?

JSON Schema es una especificación que define la estructura de datos JSON. Su objetivo principal es proporcionar un vocabulario y un conjunto de reglas para describir el formato de los datos JSON, incluyendo tipos de datos, propiedades, valores permitidos y relaciones entre ellos.

Beneficios de usar JSON Schema

Usar JSON Schema ofrece una serie de ventajas, entre las que destacan:

• Documentación: Actúa como una especificación clara y concisa del formato de datos JSON, facilitando la comprensión y el uso de los datos.
• Validación: Permite verificar que los datos JSON cumplan con la estructura definida, asegurando la integridad de la información.
• Interoperabilidad: Facilita la interoperabilidad entre diferentes sistemas, al establecer un formato común para los datos.
• Automatización: Permite la validación automatizada de los datos, lo que agiliza los procesos y reduce la posibilidad de errores.

JSON Schema y su Formato

JSON Schema está escrito en formato JSON, lo que lo hace legible tanto para humanos como para máquinas. Este formato permite definir las reglas de la estructura de los datos JSON a través de un conjunto de keywords y valores.

Keywords Clave en JSON Schema

JSON Schema utiliza una serie de keywords para describir la estructura de los datos JSON. Algunas de las keywords más comunes incluyen:

• «$schema»: Define la versión del esquema utilizado.
• «title»: Proporciona un título descriptivo para el esquema.
• «description»: Describe el propósito del esquema.
• «type»: Define el tipo de datos (por ejemplo, string, integer, boolean, array, object).
• «properties»: Define las propiedades del objeto y su tipo de datos.
• «required»: Indica las propiedades que son obligatorias.
• «minimum»: Define el valor mínimo permitido para un campo numérico.
• «exclusiveMinimum»: Define el valor mínimo permitido, excluyendo el valor mínimo definido.
• «maximum»: Define el valor máximo permitido para un campo numérico.
• «exclusiveMaximum»: Define el valor máximo permitido, excluyendo el valor máximo definido.
• «multipleOf»: Define que un valor debe ser un múltiplo de un número específico.
• «maxLength»: Define la longitud máxima permitida para una cadena de caracteres.
• «minLength»: Define la longitud mínima permitida para una cadena de caracteres.
• «pattern»: Define una expresión regular que debe coincidir con la cadena de caracteres.

JSON Schema en Acción: Un Ejemplo Práctico

Para ilustrar cómo funciona JSON Schema, consideremos un ejemplo práctico que describe un catálogo de productos:

json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Catálogo de Productos",
"description": "Esquema para la descripción de productos en un catálogo.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Identificador único del producto",
"minimum": 1
},
"nombre": {
"type": "string",
"description": "Nombre del producto",
"minLength": 3
},
"precio": {
"type": "number",
"description": "Precio del producto",
"minimum": 0
},
"stock": {
"type": "integer",
"description": "Cantidad de unidades en stock",
"minimum": 0
},
"categoria": {
"type": "string",
"description": "Categoría del producto",
"enum": ["Electrónica", "Ropa", "Alimentos"]
}
},
"required": ["id", "nombre", "precio", "stock", "categoria"]
}
}


Este esquema define un array de objetos, cada uno representando un producto. Cada objeto tiene las propiedades «id», «nombre», «precio», «stock» y «categoria». Las propiedades «id», «nombre», «precio», «stock» y «categoria» son obligatorias y se establecen tipos de datos, valores mínimos, longitudes mínimas y enumeraciones para garantizar la validez de los datos.

JSON Schema y Validación de Datos

JSON Schema se puede utilizar para validar datos JSON, asegurándose de que cumplan con la estructura definida. Existen bibliotecas de validación para diferentes lenguajes de programación, como JSV, que permiten la validación de datos JSON contra un esquema definido.

Validación de Datos con JSV

JSV es una biblioteca de validación de JSON Schema para JavaScript. Permite validar un documento JSON contra un esquema definido y proporcionar mensajes de error detallados si se encuentran errores.

Aquí hay un ejemplo de cómo utilizar JSV para validar un documento JSON:

«`javascript
const jsv = require(‘jsv’);

const schema = {
«$schema»: «http://json-schema.org/draft-07/schema#»,
«type»: «object»,
«properties»: {
«nombre»: {
«type»: «string»
},
«edad»: {
«type»: «integer»,
«minimum»: 18
}
},
«required»: [«nombre», «edad»]
};

const data = {
«nombre»: «Juan»,
«edad»: 25
};

const report = jsv.validate(schema, data);

if (report.errors.length > 0) {
console.error(‘Error de validación:’, report.errors);
} else {
console.log(‘Datos válidos.’);
}
«`

En este ejemplo, se define un esquema con dos propiedades: «nombre» (cadena de caracteres) y «edad» (entero mayor o igual a 18). Luego se valida un documento JSON contra este esquema. Si el documento JSON cumple con el esquema, se imprime un mensaje de éxito. Si hay errores, se imprimen los mensajes de error.

Usos de JSON Schema

JSON Schema tiene una amplia gama de aplicaciones, incluyendo:

• Validación de API: Asegurar que los datos enviados y recibidos por las API cumplan con la estructura definida.
• Intercambio de datos: Establecer un formato común para el intercambio de datos entre diferentes sistemas.
• Documentación: Generar documentación de la estructura de los datos JSON de forma automática.
• Pruebas automatizadas: Utilizar JSON Schema para validar la salida de las pruebas automatizadas.
• Validación de formularios: Validar los datos introducidos en los formularios web, asegurando su integridad.
• Generación de código: Generar código para la representación de los datos JSON.

JSON Schema vs. XSD (XML Schema Definition)

JSON Schema es una alternativa a XSD (XML Schema Definition) para la definición de la estructura de datos. JSON Schema es más simple y legible que XSD, y se integra bien con el ecosistema JSON.

JSON Schema vs. JSON with Schema

Es importante comprender la diferencia entre JSON Schema y JSON with Schema. JSON Schema es una especificación para definir la estructura de datos JSON, mientras que JSON with Schema es un documento JSON que incluye un JSON Schema como parte de su contenido.

Recursos Adicionales

Para obtener más información sobre JSON Schema, puedes consultar los siguientes recursos:

• JSON Schema website: https://json-schema.org/
• JSON Schema specification: https://json-schema.org/draft-07/schema#
• JSV (JavaScript Validation library): https://github.com/geraintluff/jsv

Conclusión

JSON Schema es una herramienta poderosa para definir y validar la estructura de datos JSON. Ofrece una forma clara y legible de documentar los datos y garantizar su integridad.

Al utilizar JSON Schema, puedes mejorar la calidad de los datos, facilitar la interoperabilidad entre sistemas y automatizar la validación de datos.