Comment formater et valider du JSON (et corriger les erreurs courantes)
Apprenez à formater, valider et minifier du JSON, à lire les erreurs du parseur et à corriger virgules finales, guillemets simples et texte non échappé.
Mis à jour
Formater du JSON, c'est le réindenter pour que chaque clé figure sur sa propre ligne ; le valider, c'est vérifier qu'il respecte exactement la grammaire JSON. Collez le texte dans un formateur, lisez la première erreur qu'il signale, corrigez ce seul point et relancez. La plupart des JSON cassés comportent l'une d'environ six erreurs, toutes répertoriées ci-dessous.
Ce qu'exige réellement un JSON valide
JSON est plus strict que les littéraux d'objet JavaScript, et c'est de là que vient l'essentiel de la confusion. Les règles qui comptent :
- Les clés doivent être des chaînes entre guillemets doubles :
{"a":1}est valide,{a:1}et{'a':1}ne le sont pas. - Les valeurs de type chaîne n'utilisent que des guillemets doubles.
"it's"convient ;'single'non. - Pas de virgule finale.
[1,2,3,]échoue ;[1,2,3]passe. - Pas de commentaires.
// noteet/* note */sont tous deux des erreurs. - Les littéraux sont en minuscules :
true,false,null.True,NULLetundefinedne sont pas valides. - Les nombres ne peuvent pas avoir de zéros en tête (
007), de signe plus en tête (+5), ni valoirNaNouInfinity. - Le niveau supérieur peut être n'importe quelle valeur, mais la plupart des API attendent un objet
{}ou un tableau[].
Si vous gardez ces sept règles en tête, vous repérerez généralement le problème à l'œil nu. Quand ce n'est pas le cas, un validateur vous donne la position exacte.
Comment lire une erreur du parseur
Tout parseur JSON indique la position à laquelle il a abandonné, qui n'est pas forcément celle de l'erreur. Unexpected token } in JSON at position 42 signifie que le parseur a rencontré un } alors qu'il attendait autre chose, en général parce que la ligne précédente se termine par une virgule finale. Unexpected end of JSON input signifie qu'un crochet ou un guillemet a été ouvert sans jamais être refermé. Unexpected token ' signifie presque toujours des guillemets simples.
L'approche pratique : regardez la position signalée, puis reculez d'un élément. Le formateur JSON signale l'erreur directement dans le texte, à cette position, pour que vous n'ayez pas à compter les caractères vous-même.
Corriger les erreurs courantes
Virgules finales
Copier depuis du JavaScript, des dicts Python ou des fichiers de configuration modifiés à la main laisse une virgule après le dernier élément. Supprimez la virgule devant chaque } et chaque ]. Les linters la tolèrent en JS ; JSON, jamais.
Guillemets simples et clés sans guillemets
La sortie de print(dict) en Python, {'name': 'Ada', 'age': 36}, ressemble à du JSON mais n'en est pas. Remplacez ' par " et mettez entre guillemets toutes les clés nues. Si la source est en Python, utilisez json.dumps() au lieu de str() pour obtenir du vrai JSON.
Caractères non échappés dans les chaînes
Un guillemet double ou un saut de ligne littéral à l'intérieur d'une chaîne doit être échappé : "She said \"hi\"" et "line one\nline two". Les barres obliques inverses deviennent elles-mêmes \\ : un chemin Windows s'écrit donc "C:\\Users\\ada". Les tabulations s'écrivent \t, et tout point de code Unicode peut s'écrire sous la forme \u00e9.
Encodage et caractères invisibles
Une marque d'ordre d'octets en début de fichier, des guillemets typographiques collés depuis un document ou une espace insécable entre deux éléments produisent tous des erreurs déroutantes sur une ligne qui semble propre. Retapez les guillemets suspects et enregistrez le fichier en UTF-8 sans BOM.
Documents concaténés ou encapsulés
Les fichiers journaux contiennent souvent un objet JSON par ligne. Le fichier entier n'est pas du JSON valide ; chaque ligne l'est. Découpez sur les sauts de ligne et analysez chaque ligne séparément, ou entourez les lignes de [ et ] en les séparant par des virgules. De même, une réponse d'API encapsulée dans un callback comme cb({...}) est du JSONP : retirez donc d'abord l'appel de fonction.
Mise en forme lisible ou minification
Le JSON mis en forme utilise deux ou quatre espaces par niveau d'imbrication et une clé par ligne : c'est ce qu'il vous faut pour la lecture, les diffs et les fichiers de configuration versionnés dans git. Le JSON minifié supprime tous les espaces pour tenir sur une seule ligne : c'est ce qu'il vous faut sur le réseau ou dans une variable d'environnement. Les deux représentent les mêmes données. JSON.stringify(obj, null, 2) met en forme en JavaScript ; JSON.stringify(obj) minifie. En Python, json.dumps(obj, indent=2) fait le même travail.
Le formatage ne change jamais le sens, mais l'ordre des clés n'est pas garanti par la spécification JSON. N'écrivez pas de code qui compte sur le fait que {"b":1,"a":2} reste dans cet ordre après un aller-retour.Valider par rapport à un schéma
La validation syntaxique vous dit seulement que le texte est du JSON bien formé. Elle ne vous dit pas que "age" est un nombre ni que "email" est présent. Pour cela, il vous faut JSON Schema, avec un validateur comme Ajv en JavaScript ou jsonschema en Python. Commencez par la syntaxe, car un validateur de schéma ne peut pas s'exécuter sur un texte qui ne s'analyse pas.
Convertir depuis et vers d'autres formats
Les tableurs veulent des lignes et des colonnes, pas des objets imbriqués. Un tableau d'objets plats tel que [{"id":1,"name":"Ada"},{"id":2,"name":"Lin"}] se transpose proprement en CSV avec une ligne d'en-tête, et le convertisseur JSON vers CSV gère les champs entre guillemets et les virgules incluses, dans les deux sens. Les objets imbriqués doivent d'abord être aplatis.
Les fichiers de configuration de Kubernetes, GitHub Actions et Docker Compose sont généralement en YAML. Tout document JSON est aussi du YAML valide, mais l'inverse n'est pas vrai, puisque YAML autorise les commentaires, les ancres et les chaînes sans guillemets. Quand un fichier YAML se comporte mal, le convertir avec le convertisseur YAML vers JSON vous montre exactement comment le parseur a interprété chaque valeur, ce qui révèle la surprise classique de yes qui devient true ou de 3.10 qui devient 3.1.
Le reste des outils de mise en forme, d'encodage et de validation se trouve dans la catégorie développeur.
Essayez
Collez votre JSON en échec dans le formateur JSON. Il s'exécute dans votre navigateur, met l'erreur en évidence à la position exacte et vous permet de passer d'une sortie lisible à une sortie minifiée, avec une largeur d'indentation personnalisée.