Jika kamu seorang back-end developer pasti familiar dengan API (Application Programming Interface). Dan biasanya, ketika kita mendevelop API dari program yang kita bangun, kita wajib menyediakan dokumentasi APInya kan ? minimal kita menyediakan link, method dan deskripsi singkat mengenai fungsi dari API tersebut. Biasanya kita tulis di file .txt atau markdown. apakah kamu masih seperti itu ?
Jika kamu masih seperti itu, sudah saatnya untuk mengenal tools generator untuk dokumentasi API, terutama untuk RESTful Web Service. Diluar sana, banyak sekali tools generator untuk membuat dokumentasi API dengan cepat dan bagus, seperti apidocjs, swagger, Slate dan lain sebagainya.
APIDOCjs
Kalau dari saya sendiri saya lebih suka menggunakan apidocjs karena mudah dan sederhana. Tampilanya sudah cukup bagus dan ringan untuk API Documentation. Contohnya seperti berikut ini.
Fiturnya cukup lengkap, seperti :
- Navigasi
- API Method
- Versioning API
- Contoh Respon API yang benar dan salah
- Search
Jadi lebih keren kan dokumentasinya ? dan semuanya itu hanya menggunakan satu sintag saja kemudian akan digenerate dengan APIdoc. Bagaimana tertarik untuk mencoba APIDOCjs ? atau kamu menggunakan tools lain ?
Jika tertarik, silahkan kamu akses langsung melalui web resminya di http://apidocjs.com/#getting-started. Jika kamu masih bingung membaca dokumentasinya, saya sarankan untuk melihat pitchdeck dari om Peter disini https://speakerdeck.com/rottmann/api-documentation
Dan inysAllah juga saya tulis untuk tutorialnya versi indonesia dan saya publish pada artikel selanjutnya biar tidak terlalu panjang ya :)