Format Atlas

Guides

Choisir un format de configuration

Vérifiez d'abord les formats acceptés par l'outil. S'il y a plusieurs choix, retenez celui que l'équipe peut valider et maintenir sans risque.

Quel format choisir ?

Choisissez selon le rôle de chaque fichier dans votre flux de travail.

  • API et échange de données web → JSON
  • Configuration hiérarchique lisible → YAML
  • Configuration de clés et valeurs → TOML
  • Outil imposant un format → suivre sa spécification

Privilégier la prise en charge des outils

Le format dépend de l'application, de la bibliothèque, de la CI et de l'hébergement. Vérifiez les formats et versions de spécification acceptés.

Automatiser la validation syntaxique

JSON, YAML et TOML peuvent échouer à cause d'erreurs de syntaxe ou de type. Validez à l'enregistrement ou en CI et gardez les identifiants hors des fichiers de configuration du dépôt.

Formats à envisager

JSON

Adapté pour: API ou paramètres acceptant JSON

Moins adapté pour: Configuration manuelle nécessitant des commentaires

YAML

Adapté pour: Configuration hiérarchique maintenue par des personnes

Moins adapté pour: Échange simple où l'indentation risque d'être erronée

TOML

Adapté pour: Configuration organisée en clés et valeurs

Moins adapté pour: Outils exigeant JSON ou YAML

Avant l’export

  • Vérifiez format et version pris en charge par l'outil.
  • Ne stockez pas identifiants ou clés privées dans le dépôt.

Comparaisons associées

JSON vs TOMLJSON est très utilisé pour les API et les échanges entre programmes. TOML vise les configurations applicatives modifiées par des personnes, avec clés, valeurs, tables et listes lisibles.YAML vs TOMLYAML et TOML sont des formats texte utilisés pour les configurations éditées par des personnes. YAML accepte des hiérarchies souples ; TOML privilégie des réglages explicites et lisibles avec clés et tables. Choisissez selon l’outil et la structure.JSON vs YAMLJSON est un format texte strict très répandu pour les API et les échanges entre programmes. YAML propose une syntaxe adaptée aux configurations et données structurées modifiées par des personnes. Choisissez selon l’écosystème et le flux.YAML ou XMLYAML et XML représentent tous deux des données structurées. YAML est souvent pratique pour les configurations maintenues par des personnes ; XML est courant dans les intégrations dépendant d'éléments, attributs, schémas ou espaces de noms.

Guides

Choisir un format d'échange de donnéesCommencez par la spécification du système destinataire. Utilisez JSON pour les API structurées, XML si l'intégration exige son schéma et CSV pour un tableau unique.Choisir un format de données et de configuration WebEnvisagez JSON pour les échanges machine comme les API, YAML pour les configurations modifiées par des personnes et XML pour les intégrations existantes avec schéma.Où stocker les paramètres et les secretsSéparez les paramètres ordinaires des identifiants, puis choisissez leur emplacement pour le développement local, la CI et la production selon les besoins d’accès.

Références et spécifications