Tutorial Membuat Dokumentasi RESTful API dengan APIdocJS

tutorial
API, apidocjs, javascript, programmer

Seperti janji saya pada artikel Cara Cepat Membuat Dokumentasi API dengan APIDOCjs, bahwa saya akan membagikan tutorial mengenai bagaimana cara membuat Dokumentasi RESTful API dengan APIdocJS. Bagaimana ? kamu tertarik untuk mencobanya ? mari kita simak tutorial berikut ini.

Persiapan

Untuk bisa menggunakan APIDOCjs, kamu membutuhkan NodeJS termasuk npm, silahkan kamu download dan install di dekstop kamu melalui link berikut https://nodejs.org/en/

Pastikan menggunakan versi terbaru ya! (saat tulisan ini dibuat, versi yang direkomendasikan adalah versi 9.1.0).

Jika sudah di install, coba cek di terminal/cmd kamu dengan perintah node -vdan npm -vkemudian pastikan hasilnya muncul nomor tertentu seperti gambar dibawah ini.
Versi Node JS 7.10

Instalasi

Setelah NodeJS dan NPM terpasang dengan baik didekstop kamu, sekarang install apidocjs di dekstop kamu dengan cara :

1
npm install -g apidoc

Tunggu sampai proses Instalasi selesai.

Konfigurasi

Setelah proses instalasi apidoc selesai, hanya 2 langkah lagi yang perlu kamu siapkan, yaitu :

  1. Silahkan buka direktori kamu, dan bikin file apidoc.json dan silahkan masukan code berikut dan isi sesuai dengan kebutuhan kamu.

    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" : "http://linkapikamu.com"
      }
    }

  2. Sekarang simpan file tersebut dan silahkan buat file baru dengan ekstensi .js boleh kamu namai sesukamu. misal saya kasih nama example.js dan setelah itu baru kamu isi sesuai dengan APIdoc-Parameter sehingga dalam contoh sederhana saya seperti ini.

    dan sekarang kita punya dua file seperti berikut ini.
    File Apidoc.json dan Example.js

Finalisasi

Setelah tahap Konfigurasi selesai, sekarang buka terminal kamu pada folder tersebut dan esekusi perintah berikut

1
apidoc

apidoc
Dan tadaa.. muncul satu folder doc hasil generate dari apidoc dan silahkan buka folder /docdan jalankan file index.html melalui browser kamu.
Hasilnya

Bagaimana ? sangat mudah dan cepat bukan ? :D semoga bermanfaat ya :) barakallah :)

Bagikan Komentar