Esquema JSON

JSON Schema es un lenguaje de especificación de contenido utilizado para validar la estructura de datos JSON. Le ayuda a especificar los objetos y qué valores son válidos dentro de las propiedades del objeto. El esquema JSON es útil para ofrecer documentación clara, legible por humanos y legible por máquina.

Estructura de un esquema JSON: Dado que el formato JSON contiene un objeto, una array y elementos de par nombre-valor. Los pares de nombre y valor se utilizan para proporcionar elementos de procesamiento de esquemas, así como para validar el contenido JSON. Los elementos de procesamiento del esquema incluyen (no se limitan a).

• $schema” Para especificar la versión del esquema JSON.
• título y descripción: para proporcionar información sobre el esquema.
• requerido: Es una array de elementos que indica qué elementos deben estar presentes.
• AdditionalProperties: para indicar si la existencia de elementos específicos está permitida o no.

Definición de contenido JSON:

• Cuando se define un objeto JSON, el esquema JSON usa el par nombre-valor «tipo»:»objeto»
• Cuando se definen arrays, el esquema JSON utiliza el par nombre-valor «tipo»:»array»

Ejemplo:

{
  "$id": "https://example.com/person.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Voters information",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    },
    "age": {
      "description": "Age in years which must be equal to or 
                      greater than eighteen in order to vote.",
      "type": "integer",
      "minimum": 18
    }
  }
}

Producción:

{
  "firstName": "Indra",
  "lastName": "Sen",
  "age": 20
}

El esquema JSON anterior contiene lo siguiente:

• $id palabra clave
• $schema palabra clave
• palabra clave de anotación de título
• palabra clave de validación de propiedades
• Tres claves: firstName , lastName y age , cada una con su propia palabra clave de descripción.
• modelo de datos de instancia de tipo (ver arriba)
• palabra clave de validación mínima en la clave de edad.