Format Atlas

Panduan

Memilih format data web dan konfigurasi

Pertimbangkan JSON untuk pertukaran antarmesin seperti API, YAML untuk pengaturan yang diedit manusia, dan XML untuk integrasi lama berbasis skema.

Format mana yang sebaiknya dipilih?

Pilih berdasarkan peran setiap berkas dalam alur kerja.

  • API web → JSON
  • Pengaturan yang diedit manusia → YAML
  • Skema atau kontrak lama → XML

Gunakan format yang diminta penerima

Ketiganya mewakili data terstruktur, tetapi berbeda dalam sintaks, komentar, penafsiran tipe, dan alur skema. Periksa kontrak serta alat terlebih dahulu.

Format yang disarankan

JSON

Cocok untuk: API dan pertukaran berbasis JSON

Kurang cocok untuk: Pengaturan manual yang perlu komentar

YAML

Cocok untuk: Konfigurasi yang dipelihara manusia

Kurang cocok untuk: API yang hanya menerima JSON

XML

Cocok untuk: Skema dan integrasi XML lama

Kurang cocok untuk: API sederhana baru tanpa syarat XML

Periksa sebelum mengekspor

  • Jangan berasumsi YAML adalah superset ketat JSON.
  • Pastikan enkoding, tipe, dan penanganan skema bersama penerima.

Perbandingan terkait

Panduan

Referensi dan spesifikasi