Skip to content

ibnumardini/wilayah-indonesia-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wilayah Indonesia API

Visitors License Go MySQL Vercel

REST API for Indonesian regional data (Provinces, Regencies/Cities, Districts, and Sub-districts/Villages).

Data Source

This API uses data fetched from BPS (Statistics Indonesia) using @ibnumardini/wilayah-indonesia CLI package.

Features

  • Province data
  • Regency/City data
  • District data
  • Sub-district/Village data
  • Swagger Documentation

Tech Stack

  • Go 1.23.1
  • Chi Router
  • MySQL Database
  • Swagger/OpenAPI

API Endpoints

Base URL

https://wilayah-indonesia-api.mardini.dev

Endpoints

  • GET / - Welcome message
  • GET /provinces - List of provinces
  • GET /regencies - List of regencies/cities
  • GET /districts - List of districts
  • GET /subdistricts - List of sub-districts/villages
  • GET /swagger/index.html - API Documentation

Development

Development using vercel/cli, so the first step is install it & deploy the project to https://vercel.com

Prerequisites

  • Go 1.23.1 or higher
  • Vercel CLI
  • MySQL Database

Installation

  1. Clone repository

    git clone https://github.com/ibnumardini/wilayah-indonesia-api.git
    cd wilayah-indonesia-api
  2. Install dependencies

    go mod tidy
  3. Set up environment variables (in vercel dashboard)

  4. Run the application

    vercel dev

Deployment

Deploy with Vercel

This API is deployed on Vercel. Check vercel.json for deployment configuration.

Documentation

API documentation is available at /swagger/index.html endpoint.

About

This is a REST API for managing Indonesian administrative regions.

Topics

Resources

License

Stars

Watchers

Forks

Languages