Esquema JSON para JSON

Esquema JSON para JSON

¿Qué es un esquema JSON?

Un esquema JSON es un documento JSON que define la estructura y las reglas de validación para otro documento JSON. Es similar a un esquema XML, pero está específicamente diseñado para JSON.

Los esquemas JSON se utilizan para:

• Validar datos JSON: Asegurar que los datos JSON cumplan con una estructura y formato específicos.
• Documentar la estructura de los datos JSON: Proporcionar información clara y concisa sobre cómo se deben estructurar los datos JSON.
• Generar datos JSON: Crear automáticamente documentos JSON válidos.
• Intercambiar datos JSON: Facilitar el intercambio de datos JSON entre diferentes aplicaciones.

¿Cómo se estructura un esquema JSON?

Un esquema JSON se compone de una serie de palabras clave y valores que definen las reglas de validación para el documento JSON correspondiente. Las palabras clave más comunes incluyen:

• $schema: Especifica la versión del esquema JSON que se utiliza.
• title: Proporciona un título descriptivo para el esquema JSON.
• type: Define el tipo de dato principal para el documento JSON. Puede ser uno de los siguientes:
  • object: Un objeto JSON, que es una colección de pares nombre-valor.
  • array: Un array JSON, que es una lista ordenada de valores.
  • string: Una cadena de caracteres JSON.
  • number: Un número JSON.
  • boolean: Un valor booleano JSON (true o false).
  • null: El valor null JSON.
• properties: Define las propiedades de un objeto JSON. Cada propiedad se define como un par nombre-valor, donde el nombre es el nombre de la propiedad y el valor es un esquema JSON que define las reglas de validación para la propiedad.
• required: Especifica una lista de propiedades que son obligatorias para un objeto JSON.
• additionalProperties: Determina si se permiten propiedades adicionales en un objeto JSON.
• items: Define las reglas de validación para los elementos de un array JSON.
• minItems: Especifica el número mínimo de elementos que debe tener un array JSON.
• maxItems: Especifica el número máximo de elementos que puede tener un array JSON.
• pattern: Define una expresión regular que debe coincidir con el valor de una propiedad o elemento JSON.
• enum: Especifica una lista de valores válidos para una propiedad o elemento JSON.

Ejemplo de esquema JSON

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Ejemplo de esquema JSON",
  "type": "object",
  "properties": {
    "nombre": {
      "type": "string",
      "minLength": 3,
      "maxLength": 20
    },
    "edad": {
      "type": "integer",
      "minimum": 18,
      "maximum": 100
    },
    "email": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9.+_-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
    },
    "aficiones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 5
    }
  },
  "required": ["nombre", "edad", "email"]
}

Este esquema JSON define la estructura y las reglas de validación para un documento JSON que representa a una persona. Especifica que el documento debe ser un objeto con las propiedades nombre, edad, email y aficiones. También define reglas para cada propiedad, como el tipo de dato, la longitud mínima y máxima, el formato de correo electrónico y el número de aficiones permitidas.

Herramientas para trabajar con esquemas JSON

Existen varias herramientas que pueden ayudarte a trabajar con esquemas JSON, como:

• Validadores JSON: Estos validadores comprueban si un documento JSON cumple con un esquema JSON específico.
• Generadores de esquemas JSON: Estas herramientas generan automáticamente un esquema JSON a partir de un ejemplo de documento JSON.
• Editores de esquemas JSON: Estos editores te permiten crear y editar esquemas JSON de forma visual.

Recursos adicionales

• JSON Schema
• JSON Schema Validator