API Documentation – M. Harits Nur Fauzan

Pada kesempatan kali ini, saya akan bercerita tentang API documentation atau juga dikenal dengan programmers documentation.

Dimulai dengan pengertian API itu sendiri adalah Application Programming Interface, dimana intinya adalah kode yang sudah dispesifikasikan untuk mengerjakan sesuatu. API dibagi menjadi beberapa jenis, diantaranya adalah Software API, HCPI (Hardware API), dan WebAPI. Jenis API yang kami gunakan di kelompok kami adalah WebAPI, dimana API yang kami gunakan berupa HTTP request messages dan mengeluarkan response berupa JSON.

API documentation itu sendiri adalah sebuah upaya untuk mendokumentasi API yang sudah dibuat guna pengguna lain dapat menggunakan API tersebut secara baik dan seharusnya.

Pada kelompok kami, tools yang kami gunakan untuk mendokumentasikan API adalah apiary.io. Berikut adalah contoh salah satu dokumentasi kelompok kami:

Screen Shot 2017-05-02 at 4.03.48 PM.png

Pada gambar diatas, bagian sebelah kiri menunjukkan list API yang sudah kami buat (Challenge, History, dll) dan pada sebelah kanan terdapat detail API apa yang sedang dibuka. Detail yang ditampilkan berupa method apakah API tersebut, response apa yang akan dikeluarkan, dan seperti apakah outputnya.

Screen Shot 2017-05-02 at 4.12.14 PM.png

Pada bagian sebelah kanan seperti gambar diatas juga dapat diganti fungsinya menjadi console, sehingga kita bisa melakukan testing seperti kita melakukannya di postman.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s