Les trois opérations à distinguer
Avant de modifier un fichier JSON, il est important de comprendre le rôle de chaque opération :
- Valider : vérifier que le contenu respecte la syntaxe JSON.
- Formater ou indenter : ajouter des retours à la ligne et des espaces pour faciliter la lecture.
- Minifier : supprimer les espaces et les retours à la ligne inutiles afin de réduire la taille du fichier.
Le formatage et la minification ne remplacent pas la validation. Un fichier peut sembler correctement présenté tout en contenant une erreur de syntaxe.
Vérifier la syntaxe JSON
Un document JSON peut contenir des objets, des tableaux, des chaînes de caractères, des nombres, true, false et null. Les propriétés d’un objet utilisent des guillemets doubles et les virgules finales sont interdites.
Exemple de JSON valide
{
"nom": "Outiko",
"actif": true,
"services": ["SEO", "Contenu"]
}
Erreurs fréquentes
Les chaînes JSON doivent utiliser des guillemets doubles :
{
'nom': 'Outiko'
}
Cette version est invalide. Une virgule finale rend également le document invalide :
{
"nom": "Outiko",
}
Les noms de propriétés devraient aussi être uniques dans un même objet. Avec des doublons, le résultat peut varier selon l’outil utilisé.
Valider un JSON avec JavaScript
En JavaScript, JSON.parse() analyse une chaîne selon la grammaire JSON. En cas d’erreur, la méthode déclenche une exception SyntaxError.
const contenu = '{"nom":"Outiko","actif":true}';
try {
const donnees = JSON.parse(contenu);
console.log("JSON valide", donnees);
} catch (erreur) {
console.error("JSON invalide :", erreur.message);
}
Cette méthode contrôle uniquement la syntaxe. Elle ne vérifie pas automatiquement la présence des champs attendus ni les règles métier appliquées à leurs valeurs.
Formater un fichier JSON avec JavaScript
Pour formater un JSON, commencez par le parser puis utilisez JSON.stringify(). Son troisième argument définit le niveau d’indentation. La valeur 2 correspond à deux espaces.
const contenu = '{"nom":"Outiko","actif":true,"services":["SEO","Contenu"]}';
const donnees = JSON.parse(contenu);
const jsonFormate = JSON.stringify(donnees, null, 2);
console.log(jsonFormate);
Le résultat sera indenté ainsi :
{
"nom": "Outiko",
"actif": true,
"services": [
"SEO",
"Contenu"
]
}
Minifier un JSON avec JavaScript
Pour obtenir une version compacte, appelez JSON.stringify() sans argument d’indentation :
const donnees = {
nom: "Outiko",
actif: true,
services: ["SEO", "Contenu"]
};
const jsonMinifie = JSON.stringify(donnees);
console.log(jsonMinifie);
Résultat :
{"nom":"Outiko","actif":true,"services":["SEO","Contenu"]}
La minification supprime uniquement les espaces de présentation. Elle ne doit pas modifier les valeurs du document.
Valider et formater un JSON avec jq
jq est un outil en ligne de commande qui permet de lire, vérifier, filtrer et produire des données JSON.
Valider et formater
Pour vérifier et afficher un fichier avec une indentation lisible :
jq . fichier.json
Pour enregistrer le résultat dans un autre fichier :
jq . fichier.json > fichier-formate.json
Si le contenu n’est pas valide, jq renvoie une erreur.
Minifier avec jq
L’option -c, ou --compact-output, produit une sortie compacte :
jq -c . fichier.json > fichier-minifie.json
Contrôler un fichier dans un script
if jq empty fichier.json >/dev/null 2>&1; then
echo "JSON valide"
else
echo "JSON invalide"
fi
Vérifier la structure avec JSON Schema
Un JSON peut être syntaxiquement valide tout en ne respectant pas la structure attendue par une application. JSON Schema permet alors de définir les types, les propriétés obligatoires, les propriétés autorisées et les contraintes sur les chaînes, les nombres, les objets et les tableaux.
Il faut distinguer :
- le document JSON à contrôler, appelé instance ;
- le schéma qui décrit les règles attendues ;
- le validateur qui compare l’instance au schéma.
Exemple de schéma :
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"nom": {
"type": "string"
},
"actif": {
"type": "boolean"
}
},
"required": ["nom", "actif"]
}
Avec ce schéma, un document sans propriété nom ou contenant une chaîne à la place d’une valeur booléenne pour actif peut être refusé, même s’il est syntaxiquement valide.
Procédure recommandée
- Conservez une copie du fichier original.
- Validez sa syntaxe avec
JSON.parse(),jqou un outil équivalent. - Formatez-le pour faciliter la relecture et la maintenance.
- Utilisez JSON Schema si des règles de structure ou de métier doivent être contrôlées.
- Corrigez les erreurs signalées puis relancez la validation.
- Minifiez uniquement la version destinée à la transmission ou à la production.
- Conservez une version formatée dans le dépôt ou la documentation.