Validar tu JSON

Qué prohíbe realmente JSON

La gramática de JSON es deliberadamente mínima, y casi todos los fallos de validación se deben a unas pocas cosas que la gente toma de JavaScript y que JSON nunca adoptó. Una coma final después del último elemento. Comillas simples en lugar de dobles. Claves sin comillas. Comentarios: JSON no tiene ni tuvo nunca. NaN e Infinity, que son números válidos en JavaScript y no son JSON válido. Y una marca de orden de bytes (BOM) al principio, invisible en cualquier editor, que algunas herramientas de Windows agregan al guardar como UTF-8 y que hace que un documento perfectamente correcto falle en su primer carácter.

Hay dos cosas que están permitidas y aun así te darán problemas, y por eso “válido” no es lo mismo que “correcto”. Las claves duplicadas no están prohibidas por la especificación, pero cada parser las resuelve de forma distinta (la mayoría se queda con la última), así que un documento con una clave repetida se valida aquí y significa cosas distintas en distintos lenguajes. Y los números no tienen un límite de precisión definido en JSON, mientras que la mayoría de los parsers los leen como punto flotante: un entero por encima de unos nueve mil billones se redondea sin avisar, y por eso los identificadores grandes se envían tan a menudo como cadenas.

Lo que obtienes es la línea, la columna y el carácter exactos donde se detuvo el análisis, lo que suele ser más útil que el propio mensaje. Un parser informa del punto en que el documento dejó de tener sentido, no de dónde se cometió el error: una llave de cierre que falta se informa al final del archivo, y una coma que falta se informa en el token siguiente. Mirar justo antes de la posición indicada es el hábito que más tiempo ahorra.

Bien formado no es lo mismo que correcto, y la distinción importa. Esto confirma que la sintaxis se puede analizar. Si el documento contiene los campos que exige tu API, si un valor está dentro del rango, si una fecha es realmente una fecha: nada de eso es una cuestión de JSON. Eso es validación de esquema, necesita un esquema, y un documento puede ser impecable aquí y ser rechazado de inmediato por el servicio al que lo envías.

Si buscas otra cosa

Para comprobar documentos contra un esquema en lugar de una gramática, JSON Schema es el estándar y ajv es su implementación más rápida: te dirá que falta un campo obligatorio o que un valor está fuera de rango, que suele ser la pregunta que de verdad tienes. check-jsonschema ejecuta las mismas comprobaciones desde la línea de comandos y en CI.

Para cualquier cosa en la línea de comandos, jq es la herramienta que hay que tener: jq empty file.json valida y no imprime nada si todo va bien, justo lo que necesita un script, y jq . da formato. Para archivos demasiado grandes para caber en memoria, jq --stream e ijson de Python analizan de forma incremental, algo que ninguna página que carga el documento entero puede hacer.