Ratgeber
Ein Konfigurationsformat wählen
Prüfe zuerst, welche Formate das Zielwerkzeug akzeptiert. Bei mehreren Möglichkeiten wähle ein Format, das das Team sicher prüfen und pflegen kann.
Welches Format sollten Sie wählen?
Wählen Sie nach der Rolle der Datei in Ihrem Arbeitsablauf.
- APIs und Web-Datenaustausch → JSON
- Lesbare verschachtelte Konfiguration → YAML
- Konfiguration mit Schlüsseln und Werten → TOML
- Werkzeug verlangt ein Format → Vorgabe befolgen
Werkzeugunterstützung zuerst prüfen
Das Format hängt von Anwendung, Bibliothek, CI-System und Hosting ab. Prüfe unterstützte Formate und Versionen der Spezifikation.
Syntaxprüfung automatisieren
JSON, YAML und TOML können wegen Syntax- oder Typfehlern nicht geladen werden. Prüfe beim Speichern oder in CI und halte Zugangsdaten aus Konfigurationsdateien im Repository heraus.
Geeignete Formate
JSON
Geeignet für: APIs oder Einstellungen mit JSON-Unterstützung
Weniger geeignet für: Von Menschen gepflegte Einstellungen mit Kommentaren
YAML
Geeignet für: Von Menschen gepflegte verschachtelte Konfiguration
Weniger geeignet für: Einfacher Austausch, bei dem Einrückungsfehler vermieden werden sollen
TOML
Geeignet für: Konfiguration aus Schlüsseln und Werten
Weniger geeignet für: Werkzeuge, die JSON oder YAML vorgeben
Vor dem Export prüfen
- Prüfe Format und Spezifikationsversion des Zielwerkzeugs.
- Speichere keine Zugangsdaten oder privaten Schlüssel im Repository.