JSON (JavaScript Object Notation) se ha convertido en el formato por defecto para intercambiar datos entre servicios web, archivos de configuración y APIs. Es fácil de leer para las personas y trivial de procesar para las máquinas, pero también es un formato muy estricto: una coma de más, una comilla sin cerrar o un comentario mal colocado bastan para que todo el documento deje de ser válido.
Por qué JSON se rompe tan a menudo
La mayoría de los errores de JSON caen en unas pocas categorías:
- Comas finales. JSON no permite una coma después del último elemento de un array u objeto, aunque muchos lenguajes de programación sí lo toleren.
- Comillas simples. Las claves y los valores de texto deben ir entre comillas dobles. Las comillas simples, habituales en JavaScript, no son válidas en JSON.
- Comentarios. El estándar JSON no admite comentarios de ningún tipo. Si copias un fragmento de un archivo de configuración que los incluye, el analizador fallará.
- Claves sin comillas. En un objeto JavaScript puedes escribir
{ nombre: "Ana" }, pero en JSON la clave tiene que ser"nombre". - Caracteres de control sin escapar. Un salto de línea real dentro de una cadena de texto rompe el documento; hay que representarlo como
\n.
Cuando un servicio te devuelve "invalid JSON" sin más detalles, localizar el carácter exacto que falla a ojo puede llevar mucho tiempo, sobre todo en respuestas de varios miles de líneas.
Formatear frente a minificar
Hay dos operaciones opuestas que se aplican al mismo documento:
- Formatear (o embellecer) añade saltos de línea y sangría para que la estructura sea visible. Es lo que quieres cuando estás depurando una respuesta de API o revisando un archivo de configuración.
- Minificar elimina todos los espacios y saltos de línea innecesarios para dejar el documento en una sola línea. Es lo que quieres antes de enviar datos por la red o de incrustarlos en otro archivo, porque reduce el tamaño sin cambiar el contenido.
Ninguna de las dos operaciones modifica los datos: el objeto resultante es idéntico, solo cambia su presentación.
Cómo dar formato a JSON en tu navegador
El formateador de JSON de Mcatorce Suite procesa el documento completamente en tu navegador. Pega el texto y la herramienta hace tres cosas a la vez:
- Comprueba si el JSON es válido y, si no lo es, señala la línea y la posición del primer error.
- Reindenta el documento con dos espacios por nivel para que la jerarquía sea clara.
- Ofrece un botón para minificar el mismo contenido cuando lo necesites.
Como todo ocurre en local, puedes pegar respuestas que contengan tokens, datos de clientes o claves internas sin que salgan de tu equipo. Esto es una diferencia importante frente a muchos validadores en línea, que envían el texto a un servidor para procesarlo.
Buenas prácticas al trabajar con JSON
- Valida antes de guardar. Si editas a mano un
package.json, untsconfig.jsono un archivo de traducciones, pásalo por un validador antes de confirmar los cambios. Un error de sintaxis puede romper toda una build. - Usa nombres de clave consistentes. Decide entre
camelCaseosnake_casey mantenlo en todo el proyecto; mezclarlos genera errores difíciles de detectar. - No abuses del anidamiento. Estructuras con seis o siete niveles de profundidad son difíciles de leer y de mantener. A menudo conviene aplanarlas o dividirlas.
- Guarda una versión formateada para revisar y una minificada para producir. Muchos equipos versionan el archivo formateado y minifican en el paso de compilación.
Preguntas frecuentes
¿El formateador cambia el orden de mis claves? No. Se respeta el orden en el que aparecen las claves en el documento original.
¿Puedo formatear un archivo muy grande? Sí. Al ejecutarse en tu navegador, el único límite es la memoria de tu equipo; documentos de varios megabytes se procesan sin problema.
¿Se envía mi JSON a algún servidor? No. El texto nunca sale de tu navegador, así que puedes trabajar con datos sensibles con tranquilidad.