Kemudahan yang dirasakan pengguna-pengguna website seringkali tak lepas dari peran serta penyatuan API (application program interface) dengan layanan web. Para user ini mungkin tidak terpikir bagaimana ‘dapur’ di balik integrasi tersebut. Apakah serumit itu pengembangannya?
Begini. Bagi developer, menulis source code yang tidak terstruktur itu seperti membalikkan telapak tangan. Semudah itu membuatnya, tapi hal tersebut kurang lebih akan menghasilkan API web-nya yang menyebabkan website yang acak-acakan. Ya, kalau bukan user, setidaknya permasalahan ini akan dirasakan sendiri oleh sang developer.
Maka, kerumitan ini bisa dibilang bermuara dari bagaimana developer menulis API. Mestinya, rancangan API itu bisa dinikmati user saat digunakan dan dinikmati developer saat mengembangkannya, ‘kan?
Dokumentasi API yang apik adalah pintu untuk menjadi API writer yang baik. Pendokumentasian ini dimulai dari mengubah sudut pandang dari developer menjadi user. Developer perlu menggunakan pemikiran “bagaimana API ini dimanfaatkan dengan effort yang sesedikit mungkin” dibanding memikirkan “apa saja yang bisa dilakukan oleh API ini.”
Pendokumentasian API yang memuaskan bagi user dan developer semestinya melewati beberapa tahapan. Dokumentasi secara sederhana perlu berisi:
- Keterangan yang jelas mengenai method/resource
- Daftar parameter yang digunakan dalam method/resource tersebut, yang menyertakan tipenya, special formatting, rules, dan keterangan apakah resource/method ini digunakan
- Sample call yang menyertakan sambungan ke media type body
- Sample body yang menyertakan media type body
- Contoh code untuk sejumlah bahasa pemrograman
- Contoh SDK yang memperlihatkan cara mengakses method/resource dengan menggunakan SDK sesuai dengan bahasanya
- Link ke resource tambahan (contoh, blog)
- Comment section agar user dapat berbagi dan mendiskusikan code di dalamnya.
Delapan konten di atas baru sebagian dari isi dokumentasi API. Lebih luas lagi, pendokumentasian API juga masih separuhnya dari cara-cara menjadi API writer yang baik.
Untuk membantu developer menulis API yang developer-friendly, Head of Technologist DailySocial Tommy Dian Pratama akan berbagi lebih banyak tipsnya di acara #KamisKoding dengan tema “Writing Developer-Friendly API’s”, pada hari Kamis, 30 Maret 2017, di kantor DailySocial.
#KamisKoding adalah ajang yang tepat untuk para developer dan tech geek menikmati waktu santai di sore hari sambil berdiskusi ringan dan santai seputar tren IT development, programming, coding, dan hal lain yang berkaitan dengannya.
DailySocial mengkhususkan acara ini gratis untuk mereka yang terlibat dalam hal pengembangan IT atau yang ingin mempelajari seluk-beluk di dalamnya, dengan jatah kursi terbatas.
Tertarik? #KamisKoding sudah membuka pendaftarannya, dan bisa Anda akses di sini.
