Un formateur JSON et un validateur JSON sont liés, mais ils ne résolvent pas le même problème. Le formatage rend JSON plus facile à lire. La validation vérifie si le JSON peut être analysé. Avant de coller un extrait dans des documents, un champ de configuration, un problème ou une réponse d'assistance, vous aurez peut-être besoin de l'un ou des deux.
Le Convertisseur JSON / YAML / TOML de Converty conserve ces tâches ensemble : validez l'entrée, formatez-la pour examen, réduisez-la lorsque la sortie compacte est importante et convertissez-la lorsque le système suivant attend YAML ou TOML.
Utilisez un formateur lorsque le JSON est difficile à lire
Le formatage concerne la présentation. Il ajoute des indentations et des sauts de ligne afin que la structure soit plus facile à inspecter.
Utilisez le formatage lorsque :
- une charge utile est réduite en une seule ligne
- les objets imbriqués sont difficiles à suivre
- un exemple d'API doit être présenté dans la documentation
- les réviseurs doivent comparer les champs rapidement
- une réponse d'assistance nécessite un extrait lisible
Le formatage ne prouve pas que l'exemple est sémantiquement correct. Cela rend simplement la structure visible.
Utilisez un validateur lorsque le JSON peut être invalide
La validation concerne l'analyse. Il détecte les problèmes de syntaxe tels que les virgules manquantes, les chaînes non fermées, les guillemets non valides ou les imbrications brisées.
Utilisez la validation avant de coller JSON dans un système qui rejettera les entrées non valides. C'est également utile avant de partager des exemples, car les extraits non valides font perdre du temps au réviseur et rendent la documentation moins fiable.
Utilisez les deux avant de partager des exemples importants
Le flux de travail le plus sûr est la validation en premier, le formatage ensuite. Si le JSON n'est pas analysé, corrigez-le avant de vous soucier de la présentation. Une fois qu'il est valide, formatez-le pour que les humains puissent le lire.
Cette séquence est particulièrement utile pour les exemples d'API. Pour un workflow de partage d'API ciblé, lisez Comment formater JSON avant de partager un exemple d'API.
Quand la conversion entre en scène
Parfois, le système suivant a besoin de YAML ou TOML au lieu de JSON. La conversion est une troisième tâche, distincte du formatage et de la validation. Il modifie la syntaxe tout en essayant de préserver la structure des données.
Toutes les structures ne correspondent pas clairement à tous les formats, c'est pourquoi les avertissements de compatibilité sont importants. Si la sortie TOML n'est pas disponible, lisez Pourquoi la sortie TOML n'est pas disponible pour certaines entrées JSON ou YAML.
Ouvrez le Convertisseur JSON / YAML / TOML lorsque vous devez valider, formater, réduire ou convertir des données structurées avant de les coller dans le flux de travail suivant.
