Format Atlas

Panduan

Memilih format file konfigurasi

Periksa dulu format yang diterima alat tujuan. Bila ada beberapa pilihan, pilih yang dapat divalidasi dan dipelihara tim dengan aman.

Format mana yang sebaiknya dipilih?

Pilih berdasarkan peran setiap berkas dalam alur kerja.

  • API dan pertukaran data web → JSON
  • Konfigurasi bertingkat yang mudah dibaca → YAML
  • Konfigurasi berbasis kunci dan nilai → TOML
  • Alat mewajibkan satu format → ikuti spesifikasinya

Utamakan dukungan alat

Format bergantung pada aplikasi, pustaka, sistem CI, dan lingkungan hosting. Pastikan format dan versi spesifikasi yang didukung.

Otomatiskan validasi sintaks

JSON, YAML, dan TOML dapat gagal dibaca akibat kesalahan sintaks atau tipe. Validasi saat menyimpan atau di CI, dan jangan simpan kredensial dalam file konfigurasi di repositori.

Format yang disarankan

JSON

Cocok untuk: API atau pengaturan yang menerima JSON

Kurang cocok untuk: Pengaturan manual yang memerlukan komentar

YAML

Cocok untuk: Konfigurasi bertingkat yang dipelihara manusia

Kurang cocok untuk: Pertukaran sederhana yang rawan salah indentasi

TOML

Cocok untuk: Konfigurasi berbasis kunci dan nilai

Kurang cocok untuk: Alat yang khusus mewajibkan JSON atau YAML

Periksa sebelum mengekspor

  • Pastikan format dan versi spesifikasi yang didukung alat.
  • Jangan simpan kredensial atau kunci privat di repositori.

Perbandingan terkait

JSON vs TOMLJSON banyak digunakan untuk API dan pertukaran data antaraplikasi. TOML dirancang untuk konfigurasi aplikasi yang diedit manusia, dengan kunci, nilai, tabel, dan larik yang mudah dibaca.YAML vs TOMLYAML dan TOML adalah format teks untuk konfigurasi yang diedit manusia. YAML mendukung hierarki fleksibel; TOML menekankan pengaturan eksplisit yang mudah dibaca dengan kunci dan tabel. Pilih sesuai alat dan struktur data.JSON vs YAMLJSON adalah format teks ketat yang banyak dipakai untuk API dan pertukaran data antaraplikasi. YAML menawarkan sintaks untuk konfigurasi dan data terstruktur yang diedit manusia. Pilih sesuai ekosistem dan alur kerja.YAML vs XMLYAML dan XML sama-sama merepresentasikan data terstruktur. YAML sering praktis untuk konfigurasi yang dipelihara manusia, sedangkan XML umum dalam integrasi yang bergantung pada elemen, atribut, skema, atau namespace.

Panduan

Memilih format pertukaran dataMulailah dari spesifikasi sistem penerima. Gunakan JSON untuk data API terstruktur, XML bila integrasi menuntut skema, dan CSV untuk satu tabel.Memilih format data web dan konfigurasiPertimbangkan JSON untuk pertukaran antarmesin seperti API, YAML untuk pengaturan yang diedit manusia, dan XML untuk integrasi lama berbasis skema.Tempat menyimpan konfigurasi dan rahasiaPisahkan konfigurasi biasa dari kredensial, lalu pilih penyimpanan untuk pengembangan lokal, CI, dan produksi sesuai kebutuhan akses.

Referensi dan spesifikasi