Bantenprov API

Dokumentasi API Pemerintah Provinsi Banten.

API yang tersedia

Profil API
Dashboard API
Yankes API
Simpeg API
Simbada API
SOP Online API
Otorisasi API
Satu Data API

Penyiapan alat

Untuk dapat menggunakan build system, Anda membutuhkan kode sumber dan Node. Ikuti langkah-langkah di bawah ini:

Download kode sumber.
- Atau clone: git clone https://github.com/bantenprov/api.git.
Download dan install Node, yang digunakan untuk manajemen dependensi.
Arahkan ke direktori root /api dan jalankan perintah npm install untuk instalasi dependensi yang sudah terdaftar di dalam berkas package.json.

Setelah selesai, Anda dapat menjalankan berbagai perintah yang disediakan dari command line.

Menggunakan NPM scripts

package.json meliputi commands dan tasks berikut:

Task	Description
`npm run build`	Untuk menjalankan pengujian dan kompilasi.
`npm run test`	Untuk menjalankan pengujian.

Struktur

api/
├── dist/
│   └── docs/                   # Hasil build dari `source/`
└── source/                     # Sumber API dan template
    └── <api-name>              # Nama (tiap-tiap) direktori API
        ├── api-src             # Sumber API
        │   ├── apidoc.json     # Konfigurasi API
        │   └── <api-name>.js   # Data API
        └── template            # Sumber template

Petunjuk penulisan dokumentasi API

Tulis data API di dalam berkas api-src/<api-name>.js dan konfigurasi API di dalam berkas api-src/apidoc.json. Silakan pelajari dari dokumentasi API yang sudah ada.

Dokumentasi API ini menggunakan APIDOC, silakan pelajari bagaimana menulis dokumentasi API menggunakan APIDOC di http://apidocjs.com.