API JSON berbanding XML

Pilihan antara JSON dan XML ialah sebahagian daripada kontrak antara klien dengan API. Klien perlu membezakan kejayaan, ralat validasi, kegagalan pengesahan identiti, had kadar dan ralat pelayan sementara. Memilih JSON atau XML tidak mengubah semantik HTTP, dan nilai IPv4/IPv6 mesti dikekalkan tanpa mengandaikan panjang alamat IPv4.

Cara mengendalikan respons

Sahkan Content-Type, kod status, medan yang didokumenkan dan kuota. Kendalikan HTTP 429 secara berasingan, patuhi Retry-After jika diberikan, dan gunakan exponential backoff yang terhad bersama jitter. Pertimbangkan idempotensi sebelum mencuba semula. Rekodkan pengecam permintaan, status dan kependaman dalam log, tetapi jangan sekali-kali merekodkan rahsia API.

Perkara yang perlu diberi perhatian

JSON mudah dipetakan kepada model data objek/tatasusunan yang biasa dan lazimnya padat; XML menyokong atribut, ruang nama dan alatan skema yang matang. Buat pilihan berdasarkan kontrak API dan ekosistemnya, bukan dengan mengandaikan satu format sentiasa lebih pantas atau lebih betul. Untuk permintaan sebenar dan kontrak API semasa, lihat API 2IP.