¿Qué es un esquema JSON?

La esquema JSON (JSON Schema) es un estándar léxico basado en JSON para describir la estructura y las restricciones de los datos en formato JSON. Permite validar, describir y documentar datos JSON.

Objetivos principales:

• Validación: Verificar que una instancia JSON cumple con una estructura determinada.
• Documentación: Describir el formato de los datos JSON.
• Interacción: Intercambio de metadatos entre sistemas.

Componentes clave del esquema JSON:

• Tipos de datos: string, number, integer, boolean, object, array, null.
• Palabras clave para restricciones:
  • type: Tipo de dato esperado.
  • properties: Descripción de las propiedades de un objeto. Cada propiedad tiene su propio sub-esquema.
  • required: Lista de propiedades obligatorias para un objeto.
  • items: Descripción de los elementos de un array.
  • minLength/maxLength: Restricciones de longitud para cadenas.
  • minimum/maximum: Restricciones para números.
  • pattern: Expresión regular para cadenas.
  • enum: Lista de valores permitidos.
  • allOf/anyOf/oneOf/not: Combinaciones lógicas de esquemas.
• Palabras clave para metadatos:
  • title: Título breve del esquema.
  • description: Descripción detallada del esquema.
  • default: Valor por defecto.

Ejemplo de esquema JSON:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identificador único del usuario"
    },
    "username": {
      "type": "string",
      "minLength": 3
    },
    "isActive": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "id",
    "username"
  ]
}

Ejemplo de datos JSON válidos según este esquema:

{
  "id": 123,
  "username": "testuser",
  "isActive": false
}

Ejemplo de datos JSON no válidos según este esquema:

{
  "id": "abc" // Tipo incorrecto
  // Falta el campo obligatorio "username"
}

Uso del esquema JSON en QA Automation:

• Validación de respuestas API: Verificar si las respuestas JSON cumplen con el formato establecido.
• Validación de solicitudes: Verificar los datos JSON entrantes antes de procesarlos.
• Generación de datos de prueba: Usar el esquema para crear ejemplos de prueba válidos (o no válidos).
• Documentación: Crear documentación de API que se actualiza automáticamente.

Existen bibliotecas para trabajar con esquemas JSON en varios lenguajes de programación (por ejemplo, jsonschema para Python, json-schema-validator para Java).