dokumentasi API gedung

Tata Cara Membuat Dokumentasi API dengan APIdocJS

Info Terkini

Tools generator yang bisa dimanfaatkan untuk membuat dokumentasi API sebagaimana yang kita tahu sangat banyak jenisnya. Salah satunya APIdocJS. Apa itu APIdocJS?

APIdocJS merupakan suatu tools generator yang hadir dengan interface sangat mudah untuk membantu proses pendokumentasian API. Fitur dari APIdocJS sendiri sangat banyak mulai dari terdapatnya tombol navigasi, versioning API, tombol search, API method dan percontohan respon API. Untuk membuat dokumentasi dengan APIdocJS, berikut tata caranya!

Tata Cara Membuat Dokumentasi API dengan APIdocJS

Tahap persiapan

Cara pembuatan dokumentasi API dengan menggunakan APIdocJS yang pertama adalah melalui tahap persiapan. Anda butuh NodeJS termasuk juga NPM untuk pembuatan dokumentasi API sehingga Anda harus melakukan download dan instalasi dulu di desktop.

dokumentasi API informasi lengkap terbaru mengenai

Untuk mendownload NodeJS di desktop, Anda bisa klik link https://nodejs.org/en/

Pastikan download versi terbaru NodeJS. Jika Anda sudah download dan instalasi di desktop, coba cek terminal atau cmd dengan menggunakan perintah node –v dan npm –v kemudian pastikan bahwa hasilnya muncul. Hasil yang muncul adalah nomor tertentu.

Tahap instalasi

Jika NodeJS dan NPM sudah terpasang dengan baik melalui desktop, sekarang waktunya Anda instalasi apidocjs melalui desktop dengan cara :

Inspall (npm install -g apidoc)
Tunggu sampai proses instalasinya selesai

Tahap konfigurasi

Setelah melalui tahap persiapan dan instalasi, sekarang masuk ke tahap konfigurasi. Tahap konfigurasi merupakan tahap setelah proses instalasi apidoc selesai. Ada dua langkah yang perlu dilakukan untuk menuntaskan tahap konfigurasi yaitu :

Pertama buka direktori dan buat file apidoc.json. Setelah itu masukkan kode berikut ini dan isi kode sesuai kebutuhan Anda
1
2
3
4
5
6
7
8
9 {
“name”: “Judul Dokumentasi API”,
“version”: “0.1.0”,
“description”: “isi deskripsi disni”,
“apidoc”: {
“title”: “isi sesuai kebutuhan”,
“url” : “isi url kamu”
}
}

Tahap kedua, jika sudah Anda masukkan kode di atas dengan penyesuaian sesuai kebutuhan Anda tentunya kemudian simpan file dan silahkan Anda buat file baru dengan menggunakan ekstensi .js. Namanya bisa Anda namai sesuai kebutuhan Anda.

dokumentasi API deposito bri

Tahap finalisasi

Jika tahap konfigurasi sudah selesai, sekarang Anda masuk ke tahap akhir. Buka terminal di bagian folder kemudian akan muncul satu folder doc hasil generate dari apidoc. Kemudian Anda buka folder /doc dan jalankan file indes.html melalui browser Anda.

Jika Anda belum pernah menggunakan APIdocJS, namun pernah menggunakan tools generator yang lain, Anda juga bisa menggunakan tools generator lainnya untuk mendokumentasikan atau menulis script API di aplikasi Anda.
Ada banyak tools generator lain yang bisa Anda gunakan untuk menulis API, di antaranya :

Slate : tools generator yang hadir dengan interface yang sangat mudah
Dokumentasi APIDoc : API untuk website yang terdiri atas dua kolom
FlatDoc : API dengan dokumentasi penulisan yang mudah
API Blueprint : API dengan dokumentasi otomatis yang bisa dimanfaatkan
Swagger : API dengan sistem antarmuka yang sederhana sehingga cocok untuk orang awam sekalipun
Calamum : API yang memiliki template bootstrap dan twitter
Miredot : API untuk Java
RAML : API yang simple dan ringkas
RestDoc : API yang menghasilkan dokumentasi REST dari file YAML

Anda bisa menggunakan salah satunya selain APIdocJS untuk keperluan penulisan dan dokumentasi API. Selamat belajar tentang API dan semoga menjadi informasi yang membawa manfaat.

Leave a Reply

Your email address will not be published. Required fields are marked *