JSON ou YAML : différences, quand utiliser l’un ou l’autre et comment convertir

JSON et YAML sont deux façons d’écrire le même type de données : des noms avec des valeurs, des listes et des groupes imbriqués. JSON est ce qu’échangent les API et les applications web. YAML est ce que l’on modifie à la main dans les fichiers de configuration : Docker Compose, Kubernetes, GitHub Actions, spécifications OpenAPI et bien d’autres. Connaître les deux, et savoir passer de l’un à l’autre, évite bien des tâtonnements.

Les mêmes données dans les deux formats

Voici un petit fichier de réglages en JSON :

{
  "name": "devitools",
  "version": "1.10",
  "enabled": true,
  "port": 8080,
  "country": "NO",
  "zip": "007",
  "tags": ["web", "tools"],
  "database": { "host": "localhost", "user": "admin" },
  "note": ""
}

Et les mêmes données en YAML, converties avec le convertisseur gratuit JSON en YAML :

name: devitools
version: "1.10"
enabled: true
port: 8080
country: "NO"
zip: "007"
tags:
  - web
  - tools
database:
  host: localhost
  user: admin
note: ""

YAML se passe des accolades, de la plupart des guillemets et des virgules, et indique par l’indentation ce qui va ensemble.

Les principales différences

• Structure : JSON utilise accolades, crochets et virgules ; YAML utilise l’indentation et des tirets. En YAML, l’indentation compte, et elle doit être faite avec des espaces, jamais des tabulations.
• Commentaires : YAML accepte les commentaires avec # ; JSON n’en a pas du tout. Rien que pour cela, la plupart des fichiers de configuration sont en YAML.
• Lisibilité : YAML est plus facile à lire et à modifier pour un humain ; JSON est plus facile à produire et à vérifier pour un programme, et plus difficile à casser sans s’en rendre compte.
• Rigueur : JSON n’a qu’une façon d’écrire chaque chose. YAML en a beaucoup (plusieurs styles de texte, ancres, texte sur plusieurs lignes) : c’est souple, mais il y a des surprises.
• Compatibilité : YAML 1.2 a été conçu pour qu’un JSON valide soit aussi un YAML valide ; la plupart des outils YAML lisent donc directement les fichiers JSON.

Quand utiliser l’un ou l’autre

• Utilisez JSON pour les données échangées entre programmes : API, applications web, données stockées, tout ce qui est généré automatiquement.
• Utilisez YAML pour les fichiers écrits et maintenus par des personnes : configuration, déploiement et intégration continue, métadonnées de documentation, surtout quand des commentaires sont utiles.
• Suivez l’outil : si un programme attend un format, utilisez celui-là. Les exemples de Kubernetes et de GitHub Actions sont en YAML ; le package.json de npm est en JSON.

Les pièges de YAML qui cassent les configurations

YAML devine le type des valeurs sans guillemets, et les anciens lecteurs YAML 1.1, encore courants, devinent sans retenue :

country: NO      # read as false by many YAML readers
version: 1.10    # read as the number 1.1
zip: 007         # may lose its zeros

C’est ce qu’on appelle le « problème norvégien », car le code pays de la Norvège devient false. Les mots comme yes, no, on et off, les numéros de version et les valeurs avec des zéros en tête sont à risque. La solution est simple : les mettre entre guillemets. Le convertisseur JSON en YAML le fait automatiquement. Dans l’exemple ci-dessus, "NO", "1.10", "007" et la note vide restent entre guillemets, tandis que les vrais true/false et les nombres comme 8080 sont écrits tels quels.

Convertir du JSON en YAML, étape par étape

1. Ouvrez JSON en YAML et collez votre JSON dans Entrée JSON, cliquez sur Ouvrir un fichier ou déposez un fichier .json dans le cadre. Exemple charge un modèle.
2. Choisissez l’Indentation : 2 espaces (le plus courant, comme dans les exemples de Kubernetes et de GitHub Actions) ou 4 espaces.
3. Cliquez sur Convertir en YAML, puis sur Copier ou Télécharger.

Si le JSON contient une erreur, le convertisseur indique la ligne et la colonne exactes. Les causes habituelles sont expliquées dans comment formater et valider du JSON. Après la conversion, vous pouvez ajouter des commentaires # au YAML pour expliquer vos réglages.

Autres outils JSON

• Formateur JSON : rendre le JSON lisible et trouver les erreurs.
• JSON en CSV et JSON en XML : d’autres formats pour les tableurs et les systèmes plus anciens. Voir aussi comment convertir du JSON en CSV.

Mon JSON est-il envoyé ?

Non. La conversion se fait dans votre navigateur : vos données ne quittent jamais votre appareil. Notre serveur enregistre seulement qu’une conversion a eu lieu, pour la limite quotidienne.

Questions fréquentes

YAML est-il un sur-ensemble de JSON ?

Presque. YAML 1.2 a été conçu pour que les documents JSON soient du YAML valide, et en pratique les outils YAML lisent les fichiers JSON ordinaires tels quels.

Puis-je reconvertir du YAML en JSON ici ?

Pas encore. Cet outil convertit seulement du JSON vers le YAML.

Pourquoi certaines valeurs sont-elles entre guillemets dans le YAML ?

Parce que sans guillemets, YAML pourrait les lire autrement : NO comme false, 1.10 comme 1.1, 007 comme 7. Les guillemets les gardent exactement comme dans le JSON.