Qué es JSON y para qué sirve

¿Qué es JSON?

JSON es un formato de texto ligero para el intercambio de datos. Está basado en un subconjunto de JavaScript, pero es independiente del lenguaje y se utiliza ampliamente. Su estructura se basa en pares clave-valor y listas ordenadas, lo que facilita su lectura y escritura tanto para humanos como para máquinas.

En esencia, JSON es texto. Se transmite a través de la red como una cadena de caracteres y luego se "parsea" (traduce) a estructuras de datos nativas del lenguaje que estés utilizando (como arrays, diccionarios u objetos).

Estructura básica de JSON

JSON se organiza en dos estructuras principales: objetos y arrays. Entender cómo se construyen es fundamental para trabajar con JSON de manera efectiva.

Objetos

Un objeto JSON es una colección de pares clave-valor. Cada clave es una cadena de texto (encerrada entre comillas dobles), y cada valor puede ser un tipo de dato JSON válido (string, número, booleano, null, otro objeto o un array). Los objetos se delimitan con llaves {}.

{
  "nombre": "Juan Pérez",
  "edad": 30,
  "activo": true,
  "dirección": {
    "calle": "Calle Falsa 123",
    "ciudad": "Springfield"
  }
}

Arrays

Un array JSON es una lista ordenada de valores. Los arrays se delimitan con corchetes [] y pueden contener cualquier tipo de dato JSON, incluyendo otros arrays y objetos.

[
  {"id": 1, "producto": "Camiseta"},
  {"id": 2, "producto": "Pantalón"}
]

Tipos de datos en JSON

JSON solo admite unos pocos tipos de datos, lo que lo mantiene simple y fácil de procesar:

• string: Texto encerrado entre comillas dobles. Ejemplo: "hola mundo"
• number: Números enteros o de punto flotante. Ejemplo: 10, 3.14
• boolean: Valores lógicos true o false (en minúsculas).
• null: Representa la ausencia de valor.
• object: Una colección de pares clave-valor (como se describe arriba).
• array: Una lista ordenada de valores (como se describe arriba).

Importante: JSON no tiene un tipo de dato nativo para fechas. Las fechas se representan como strings, usualmente en formato ISO 8601, por ejemplo: "2023-11-20T10:00:00Z".

Reglas estrictas que debes conocer

Aunque JSON se basa en JavaScript, es mucho más estricto en su sintaxis. Estas son las reglas más importantes que debes seguir para evitar errores:

• Comillas dobles: Las claves y los valores de tipo string deben estar siempre encerrados entre comillas dobles ("). Las comillas simples (') no son válidas.
• Comas finales: No se permiten comas después del último par clave-valor en un objeto o del último elemento en un array. Por ejemplo, {"a": 1,} es inválido.
• Comentarios no permitidos: JSON no admite comentarios. No puedes usar // ni /* */.
• Booleanos y null en minúsculas: Los valores booleanos deben ser true o false, y null debe estar en minúsculas.
• Claves como strings: Las claves de los objetos siempre deben ser strings (encerradas entre comillas dobles). No se permiten claves numéricas sin comillas.

Si recibes un error al procesar un JSON, lo más probable es que se deba a una de estas reglas.

Ejemplos prácticos: API, configuración y datos

JSON es versátil y se utiliza en diversas situaciones. Estos ejemplos ilustran cómo se usa en la práctica:

Respuesta de una API

Las APIs REST a menudo devuelven datos en formato JSON. Este es un ejemplo típico:

{
  "success": true,
  "data": {
    "usuario": {
      "id": 123,
      "nombre": "Elena",
      "email": "elena@ejemplo.com"
    },
    "roles": ["administrador", "editor"]
  },
  "error": null
}

Configuración de una aplicación

JSON es útil para almacenar la configuración de una aplicación:

{
  "appName": "Mi Aplicación",
  "debugMode": false,
  "apiEndpoint": "https://api.example.com",
  "theme": "dark"
}

Datos para enviar en una petición POST

JSON se utiliza para enviar datos al servidor, por ejemplo, al crear un nuevo recurso:

{
  "nombre": "Producto XYZ",
  "precio": 19.99,
  "cantidad": 1,
  "categoría": "Electrónicos"
}

En todos estos casos, la idea es la misma: intercambiar datos estructurados de manera legible y estándar.

JSON paso a paso: crea y valida tu primer JSON

A continuación, te guiamos en la creación y validación de un archivo JSON simple:

1. Crea un archivo JSON

Abre un editor de texto y crea un nuevo archivo. Guárdalo con la extensión .json. Por ejemplo, datos.json.

2. Define la estructura

Decide qué datos quieres almacenar. En este ejemplo, crearemos un JSON para representar información sobre un libro:

{
  "titulo": "El Señor de los Anillos",
  "autor": "J.R.R. Tolkien",
  "año": 1954,
  "generos": ["Fantasía", "Aventura"]
}

3. Guarda el archivo

Guarda el archivo datos.json en tu computadora.

4. Valida tu JSON

Visita un validador de JSON en línea. Hay muchos disponibles, como el que se recomienda al final de este artículo.

5. Copia y pega tu JSON

Copia el contenido de tu archivo datos.json y pégalo en el validador.

6. Valida y corrige

El validador te dirá si tu JSON es válido y te mostrará los errores si los hay. Corrige los errores y vuelve a validar hasta que el validador muestre que es válido.

¡Felicidades! Has creado y validado tu primer JSON.

Errores comunes y soluciones rápidas

Estos son los errores más frecuentes al trabajar con JSON, junto con sus soluciones:

La mejor práctica es validar tu JSON cada vez que tengas dudas. Un validador en línea te ahorrará tiempo y frustración.

Buenas prácticas para JSON en producción

Seguir estas buenas prácticas te ayudará a crear JSON más robustos y fáciles de mantener:

1. Usa nombres de campos consistentes

Elige una convención de nombres (por ejemplo, camelCase, snake_case o PascalCase) y utilízala consistentemente en todo tu proyecto. Esto mejora la legibilidad y reduce la probabilidad de errores. Mantener la consistencia evita confusiones y facilita la integración con otras partes de tu sistema.

2. Evita estructuras innecesariamente profundas

Si tienes anidamientos excesivos (por ejemplo, seis o más niveles), considera simplificar la estructura. Las estructuras complejas son difíciles de leer, de mantener y de manipular. Evalúa si puedes aplanar la estructura o si necesitas un modelo de datos más simple.

3. Define un contrato (schema) si el proyecto crece

Cuando varias aplicaciones consumen el mismo JSON, es crucial establecer un contrato claro. Un contrato define qué campos son obligatorios, cuáles son opcionales, los tipos de datos esperados y ejemplos. Esto reduce la posibilidad de errores y facilita la integración entre diferentes sistemas. JSON Schema (explicado más adelante) es una herramienta excelente para definir y validar estos contratos.

4. Formatea en desarrollo, minifica en producción

En el entorno de desarrollo, utiliza un formato "pretty" (con sangría y saltos de línea) para facilitar la lectura y la depuración del JSON. En producción, minifica el JSON (elimina espacios en blanco y saltos de línea) para reducir el tamaño del archivo y mejorar el rendimiento de la transmisión de datos.

5. Valida siempre el JSON externo

Si recibes JSON de fuentes externas (webhooks, APIs de terceros), siempre valida su estructura y su contenido. Esto es crucial para prevenir errores, vulnerabilidades de seguridad y problemas de rendimiento. Un validador de JSON te ayudará a detectar y rechazar datos inválidos o inesperados. Asegúrate de validar tanto la sintaxis como la estructura (usando JSON Schema si es necesario).

JSON vs. XML vs. YAML: ¿Cuándo usar cada uno?

A menudo, te encontrarás con diferentes formatos para representar datos estructurados. Aquí hay una comparación de JSON, XML y YAML:

JSON

• Pros: Simple, ligero, fácil de leer y escribir, ideal para APIs REST, ampliamente soportado.
• Contras: No admite comentarios nativos, no tiene soporte nativo para esquemas complejos, menos expresivo que XML.
• Casos de uso: APIs REST, intercambio de datos en la web, configuración simple, almacenamiento de datos en frontend.

XML

• Pros: Altamente expresivo, soporta esquemas complejos (DTD, XSD), namespaces, madurez y amplia documentación.
• Contras: Más verboso, más difícil de leer y escribir (especialmente a mano), puede generar archivos más grandes, parsing más complejo.
• Casos de uso: Integraciones legacy, intercambio de datos en sistemas empresariales, documentos estructurados complejos, configuraciones donde se requiere un esquema detallado.

YAML

• Pros: Muy legible para humanos, fácil de escribir, ideal para archivos de configuración, soporte de anclajes y referencias.
• Contras: Sensible a la indentación, parsing puede ser más susceptible a errores, no siempre es la mejor opción para APIs públicas.
• Casos de uso: Archivos de configuración (Docker, Kubernetes, CI/CD), automatización, datos legibles por humanos.

En resumen, JSON es la opción predeterminada para APIs web modernas. YAML es excelente para configuraciones legibles, y XML sigue siendo relevante para sistemas heredados y documentos estructurados complejos.

Preguntas frecuentes sobre JSON

¿JSON y JavaScript son lo mismo?

No, aunque tienen una relación. JSON se basa en la sintaxis de los objetos de JavaScript, pero es un formato de datos independiente del lenguaje. JSON es un subconjunto de JavaScript. La principal diferencia es que JSON es más estricto y no permite, por ejemplo, comentarios.

¿Por qué mi "JSON" funciona en un lugar y falla en otro?

Algunas herramientas y bibliotecas son más tolerantes con los errores de sintaxis (como las comas finales). Un parser JSON "estricto" rechazará cualquier JSON que no cumpla con las reglas. Por eso es importante validar tus JSON.

¿Cómo convierto un objeto a JSON en PHP?

En PHP, puedes usar la función json_encode() para convertir un array o un objeto en una cadena JSON. También puedes usar json_decode() para convertir una cadena JSON en un array asociativo u objeto. Asegúrate de manejar los errores utilizando json_last_error().

¿Cómo puedo formatear y validar JSON en línea?

Existen numerosas herramientas online que te permiten validar, formatear y minificar JSON. Recomendamos el Validador y Formateador de JSON, que te permite pegar tu JSON, validarlo y obtener el resultado formateado o minificado.

JSON Schema: Valida la estructura de tus datos

La validación de la sintaxis del JSON (¿es un JSON válido?) es solo el primer paso. En muchos casos, también necesitas validar la estructura y el contenido de los datos (¿tiene la forma correcta?). Aquí es donde entra en juego JSON Schema.

JSON Schema te permite definir un esquema que describe la estructura esperada de tu JSON. Puedes especificar los campos requeridos, los tipos de datos, los formatos (por ejemplo, un email), las longitudes mínimas y máximas, y más.

Por ejemplo, puedes definir que un campo email sea un string con formato de correo electrónico, que un campo id sea un entero positivo, y que un campo items sea un array con al menos un elemento. Esto te permite detectar errores y validar los datos de manera más robusta.

JSON Schema es especialmente útil en:

• APIs públicas.
• Integraciones con terceros.
• Sistemas donde la integridad de los datos es crucial.

Casos de uso reales de JSON

1. APIs REST y microservicios

JSON es el formato de datos más común para las APIs REST porque es simple y fácil de procesar. Los clientes (aplicaciones web, móviles, etc.) pueden consumir los datos JSON y mostrarlos de manera sencilla. Con HTTP + JSON, herramientas como Postman o curl te permiten depurar rápidamente tus APIs.

2. Webhooks

Los webhooks a menudo envían datos en JSON para notificar eventos (por ejemplo, "pago confirmado", "nuevo comentario"). La validación del JSON es esencial aquí, ya que los datos recibidos de terceros pueden cambiar y afectar tu aplicación.

3. Frontend y estado de la aplicación

Muchos frameworks y Single Page Applications (SPAs) utilizan JSON para serializar el estado de la aplicación, almacenar datos en caché o en el almacenamiento local del navegador. Mantener una estructura JSON consistente es fundamental para evitar errores difíciles de rastrear.

4. Archivos de configuración

Si bien YAML es popular para la configuración, JSON se usa en algunos sistemas, especialmente cuando se necesita una sintaxis simple. Recuerda que, a diferencia de YAML, JSON no permite comentarios, lo cual puede afectar la legibilidad.

Conclusión y recomendaciones

JSON es el estándar de facto para el intercambio de datos en la web moderna. Dominar sus reglas, tipos y buenas prácticas es esencial para trabajar con APIs, integraciones y desarrollo web en general.

Para tu día a día, recuerda esta regla clave: valida y formatea siempre el JSON antes de usarlo. Esto te ayudará a evitar errores comunes y a acelerar el proceso de depuración.

Cuando necesites validar, formatear o minificar JSON, usa el Validador y Formateador de JSON.