Apa Itu API Design?

API Design adalah proses merancang struktur, perilaku, atau tampilan api agar sesuai kebutuhan pengguna, teknis, dan tujuan yang ditetapkan. Secara operasional, API Design membantu memberi struktur pada pekerjaan yang berhubungan dengan arsitektur web, frontend, backend, browser, API, dan performa, terutama ketika hasil harus dapat diukur dan diulang.

Penerapannya perlu diuji terhadap requirement, kode dan aset. Hasilnya kemudian dapat dinilai melalui Core Web Vitals, response time dan error rate. Jika definisi, data, dan ruang lingkup tidak konsisten, tim mudah mengambil kesimpulan yang terlihat benar tetapi tidak relevan dengan tujuan.

1. Untuk API Design, tentukan tujuan dan ruang lingkup api sebelum memilih tool atau metode.
2. Siapkan input yang relevan seperti requirement, kode, dan data pendukung lainnya.
3. Jalankan proses dengan kriteria keberhasilan dan penanggung jawab yang jelas.
4. Review hasil melalui Core Web Vitals, response time, lalu dokumentasikan perbaikannya.

• Menghubungkan pekerjaan teknis atau operasional dengan hasil yang dapat dipahami oleh pemilik bisnis.
• Membuat definisi dan ruang lingkup API Design lebih konsisten ketika digunakan oleh beberapa tim.
• Membuat hasil API Design dapat ditinjau bersama indikator seperti Core Web Vitals, response time, dan error rate.
• Mengurangi pekerjaan ulang akibat keputusan yang tidak terdokumentasi atau definisi yang berbeda.

Salah satu konteks praktis API Design adalah saat aplikasi web berkembang cepat dan struktur kode mulai sulit dipelihara. Gunakan source code untuk menyamakan konteks, data, dan keputusan yang akan diambil. Hasilnya dapat ditinjau melalui Core Web Vitals dan response time.

Contohnya, bisnis ingin menambah fitur baru tanpa mengganggu fungsi website yang sudah berjalan. Tim mendokumentasikan kondisi awal dalam API contract, menerapkan API Design pada ruang lingkup terbatas, lalu membandingkan availability dengan conversion rate. Hasil dan alasan perubahan dicatat pada deployment checklist sebelum pendekatan diperluas.

• Menerapkan API Design tanpa menjelaskan tujuan, baseline, dan keputusan apa yang akan dipengaruhi.
• Tidak menyimpan log, baseline, atau catatan perubahan sehingga masalah yang sama sulit ditelusuri.
• Mengubah terlalu banyak faktor sekaligus sehingga penyebab peningkatan atau penurunan hasil tidak diketahui.
• Tidak menentukan pemilik tindakan sehingga temuan berhenti sebagai laporan tanpa perbaikan.