Microservice API untuk data wilayah Indonesia (provinsi, kabupaten/kota, kecamatan, desa).
- GET /api/v1/provinces
- GET /api/v1/provinces/:id
- GET /api/v1/regencies?province_id=11
- GET /api/v1/regencies/:id
- GET /api/v1/districts?regency_id=11.01
- GET /api/v1/districts/11.01.02
- GET /api/v1/villages?district_id=110101
Dokumentasi OpenAPI tersedia di src/docs/openapi.yaml.
Berikut langkah-langkah untuk menginstall dan menjalankan project ini secara lokal.
Prerequisites:
- Node.js 14+ dan
npmatauyarn - MySQL (jika Anda ingin menjalankan database lokal sesuai konfigurasi
src/config/database.js)
- Pasang dependensi
npm install
# atau
# yarn install- Siapkan environment (opsional)
- Salin
.env.exampleke.env(jika ada) dan sesuaikan variabel (PORT, DATABASE_URL, dsb.).
- Siapkan database (opsional)
- Jika Anda menggunakan database lokal, impor SQL dari folder
db/seeders/atau jalankan migrasi sesuai alur Anda. - Jalankan skrip berikut:
npm run migrate
- Menjalankan server
# jalankan langsung
node src/server.js
# atau jalankan melalui npm script (jika tersedia):
npm run start
# atau bisa juga dengan:
npm run dev- Akses API dan halaman test
- API base:
http://localhost:3000/api/v1 - Halaman pengujian interaktif (view) tersedia di:
http://localhost:3000/atauhttp://localhost:3000/test
Catatan tambahan:
- Logger error menulis ke
logs/error.log. - Jika Anda membuka
src/views/index.tpl.htmllangsung dari filesystem, klien akan fallback kehttp://localhost:3000/api/v1.