BLOG POSTS

27 October 2014

Tools Mock-up untuk Pembuatan REST API

Pada proyek terakhir yang aku (ciee,, ‘aku’ xD) kerjakan, ada banyak sekali pelajaran yang didapat. Bisa dibilang proyek XXX tersebut adalah pengalaman pertama saya dalam banyak hal. Pertama kalinya ngerjain proyek web admin pake ASP .Net MVC murni (tanpa third-party framework), pertama kalinya bikin REST API provider, pertama kalinya bikin oAuth2 provider, pertama kalinya setim sama ibenk alias ibnu, pertama kalinya bikin mekanisme server buat push notif di 3 platform, pertama kalinya ke kantor XXX di karawaci, dan pertama kali lainnya.

Skip2, saya ingin berbagi salah satu tip dalam development atau pengembangan untuk membuat REST API. Seringkali dalam pengembangan perangkat lunak yang membutuhkan API, terjebak dalam keadaan race condition. Yang dimaksud race di sini adalah balapan antara developer server dalam menyediakan API, dengan developer aplikasi klien yang mengonsumsi API tersebut. Masalah yang acap kali terjadi ialah server belum menyediakan API yang dibutuhkan oleh aplikasi klien. Apalagi kalau scope API-nya sangat besar. Nah untuk ini, ada sebuah tools online yang dapat membantu pembuatan mock-up API, jadi API bo’ong2an tapi kayak beneran, makanya namanya mock-up API.

Tools yang dimaksud yaitu Apiary. Silakan eksplor sendiri dulu ya, tutorial step by step nya insya Allah nanti nyusul. :)

Beberapa fitur/kelebihan menggunakan Apiary untuk pengembangan API:

  • Berbentuk dokumentasi sehingga mudah dibaca oleh developer aplikasi klien
  • Aplikasi klien bisa menggunakan/konek ke server Apiary untuk testing, gak perlu nunggu server
  • Developer untuk API di server bisa fokus bikin API yg sesuai di dokumentasi tanpa perlu dikejar2 developer klien
  • Segala kekurangan API yg dibutuhkan developer aplikasi klien bisa segera ditambah/diubah sesuai keinginan

Satu hal yg jadi kekurangan mungkin adalah kerja ekstra si developer API untuk membuat mock-up di Apiary ini :p. Walau begitu, menggunakan tools ini sangat membantu mempercepat pengembangan dari sisi aplikasi klien, dan juga membantu developer API terutama yang menggunakan bahasa/framework baru sehingga butuh waktu ekstra untuk implementasinya.

Credit goes to Ibenk alias Ibnu yang telah menunjukkan tools ini. Saya cuma nyebarin aja, mudah2an selanjutnya bisa ditunjukin step-by-step cara pakainya (kalau ada yg mau sih..). Oya, contoh mock-up+dokumentasi API yang sudah jadi di Apiary bisa lihat di: *menyusul*

Happy ngoding! 😀

*edited contoh Apiary karena satu dan lain hal.

Yahya Muhammad

Yahya Muhammad

Software Developer at Badr Interactive
Curious developer, IoT enthusiast
Yahya Muhammad

Latest posts by Yahya Muhammad (see all)