bmkg-api

Weather Forecast API

This repository contains a RESTful API built in Golang using GoFiber to fetch weather forecasts for all provinces in Indonesia from BMKG (Badan Meteorologi, Klimatologi, dan Geofisika).

Table of Contents

• Introduction
• Features
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
• Usage
• API Endpoints
• Contribution
• License

Introduction

This API provides a simple and efficient way to access weather forecasts for all provinces in Indonesia. It utilizes the data provided by BMKG to deliver accurate and up-to-date information.

Features

• Retrieve weather forecasts for all provinces in Indonesia.
• Data updated per 3 days.
• Lightweight and fast, built with GoFiber.

Tech Stack

• Golang
• GoFiber
• Viper

Getting Started

Prerequisites

• Golang installed on your machine.

Installation

1. Clone the repository:

   git clone https://github.com/bayazidsustami/bmkg-api
   cd bmkg-api  
   

2. Install the dependencies go mod download

3. Open file .env and adjust desired host and port

Usage

1. Run The Application :

   go run main.go
   

2. Acces the api : http://localhost:8000 (default port in config file)

Api Endpoints

• GET /api/weather/provinces: Get weather forecasts for all provinces.
• GET /api/weather/provinces/{provinceId}: Get weather forecast for a specific province.
• GET /api/weather/provinces/{provinceId}/cities: Get all cities weather forecast for a specific province.
• GET /api/weather/provinces/{provinceId}/cities/{cityId}: Get weather forecast for a specific city in province

List Province

Contribution

Feel free to contribute by opening issues or submitting pull requests. Contributions are always welcome!

License

This project is licensed under the MIT License - see the LICENSE file for details.