Case Study - Weather Api Analysis Api

📖 Information

<ul style="list-style-type:disc"> <li> This project provides a Spring Boot API for Air Quality Management, allowing users to fetch real-time and historical air quality data based on request parameters. The API supports logging for request tracking and database integration. </li> <li> Air Quality Management: <ul> <li> Retrieve real-time air quality data based on latitude, longitude, and date. </li> <li> Retrieve historical air pollution data based on city name and date range. </li> <li> City Name is mandatory in queries, while the date range is optional. If not provided, the system defaults to the last 7 days. </li> <li> Only London, Barcelona, Ankara, Tokyo, and Mumbai are supported for historical data queries. </li> <li> The API response includes pollutant categories (CO, SO2, O3, etc.), sorted chronologically in JSON format. </li> <li> Example Request: <code>/api/v1/airquality/history?city=ankara&startDate=16-01-2025&endDate=17-01-2025</code> </li> <li> Example Response: </li> <pre> { "City": "Ankara", "Results": [ { "Date": "16-05-2025", "Categories": [ { "CO": "Satisfactory" }, { "SO2": "Moderate" }, { "O3": "Satisfactory" } ] }, { "Date": "17-05-2025", "Categories": [ { "CO": "Good" }, { "SO2": "Severe" }, { "O3": "Satisfactory" } ] } ] } </pre> </ul> </li> <li> Database Integration: <ul> <li> Each query first checks the database. Only missing data will be fetched from the external API, and then stored in the database. </li> <li> A log entry is created indicating whether data was retrieved from the database or from the API. </li> <li> Example Workflow: <ul> <li>Query: `Paris, 05-01-2025 to 10-01-2025` → Data is not in the database, so it is fetched from the API and stored.</li> <li>Query: `Ankara, 05-01-2025 to 10-01-2025` → Data is not in the database, so it is fetched from the API and stored.</li> <li> Query: `Paris, 01-01-2025 to 15-01-2025` → <ul> <li>01-01-2025 to 04-01-2025 → Fetched from API and stored.</li> <li>05-01-2025 to 10-01-2025 → Fetched from the database.</li> <li>11-01-2025 to 15-01-2025 → Fetched from API and stored.</li> </ul> </li> </ul> </li> </ul> </li> <li> Logging: <ul> <li> Custom Logging Aspect: Logs details of REST controller method calls for database Integration and exceptions. </li> </ul> </li> </ul>

Explore Rest APIs

Endpoints Summary

<table style="width:100%;"> <tr> <th>Method</th> <th>Url</th> <th>Description</th> <th>Request Body</th> <th>Path Variable</th> <th>Response</th> </tr> <tr> <td>POST</td> <td>/api/v1/airquality</td> <td>Retrieve air quality data</td> <td>AirQualityRequest</td> <td>None</td> <td>CustomResponse<CustomAirQualityResponse></td> </tr> </table>

Technologies

Java 21
Spring Boot 3.0
Restful API
Mapstruct
Open Api (Swagger)
Maven
Junit5
Mockito
Integration Tests
Docker
Docker Compose
CI/CD (Github Actions - Jenkins)
Postman
TestContainer
Postgres
Prometheus
Grafana
Kubernetes
JaCoCo (Test Report)
Sonarqube

Postman

Import postman collection under postman_collection folder

Prerequisites

Define Variable in .env file

WEATHER_DB_IP=localhost
WEATHER_DB_PORT=5432
POSTGRES_USER={POSTGRES_USER}
POSTGRES_PASSWORD={POSTGRES_PASSWORD}
OPEN_WEATHER_API_KEY={OPEN_WEATHER_API_KEY}

Open Api (Swagger)

http://localhost:1100/swagger-ui/index.html

JaCoCo (Test Report)

After the command named mvn clean install completes, the JaCoCo report will be available at:

target/site/jacoco/index.html

Navigate to the target/site/jacoco/ directory.

Open the index.html file in your browser to view the detailed coverage report.

Maven, Docker and Kubernetes Running Process

Maven Run

To build and run the application with Maven, please follow the directions shown below;

$ cd weatherapianalyis
$ mvn clean install
$ mvn spring-boot:run

Docker Run

The application can be built and run by the Docker engine. The Dockerfile has multistage build, so you do not need to build and run separately.

Please follow directions shown below in order to build and run the application with Docker Compose file;

$ cd weatherapianalyis
$ docker-compose up -d

If you change anything in the project and run it on Docker, you can also use this command shown below

$ cd weatherapianalyis
$ docker-compose up --build

To monitor the application, you can use the following tools:

Prometheus:
Open in your browser at http://localhost:9090
Prometheus collects and stores application metrics.
Grafana:
Open in your browser at http://localhost:3000
Grafana provides a dashboard for visualizing the metrics.
Default credentials:
- Username: admin
- Password: admin
Define prometheus data source url, use this link shown below

http://prometheus:9090

Kubernetes Run

To build and run the application with Maven, please follow the directions shown below;

Start Minikube

$ minikube start

Open Minikube Dashboard

$ minikube dashboard

To deploy the application on Kubernetes, apply the Kubernetes configuration file underneath k8s folder

$ kubectl apply -f k8s

To open Prometheus, click tunnel url link provided by the command shown below to reach out Prometheus

minikube service prometheus-service

To open Grafana, click tunnel url link provided by the command shown below to reach out Prometheus

minikube service grafana-service

Define prometheus data source url, use this link shown below

http://prometheus-service.default.svc.cluster.local:9090

To open Sonarqube, click tunnel url link provided by the command shown below to reach out Sonarqube

minikube service sonarqube

Docker Image Location

https://hub.docker.com/repository/docker/noyandocker/jenkins-jenkins/general
https://hub.docker.com/repository/docker/noyandocker/weatherapianalysis/general

Sonarqube

Go to localhost:9000 for Docker and Go there through minikube service sonarqube for Kubernetes
Enter username and password as admin
Change password
Click Create Local Project
Choose the baseline for this code for the project as Use the global setting
Click Locally in Analyze Method
Define Token
Click Continue
Copy sonar.host.url and sonar.token (sonar.login) in the properties part in pom.xml
Run mvn sonar:sonar to show code analysis

Jenkins

Go to jenkins folder
Run docker-compose up -d
Open Jenkins in the browser via localhost:8080
Go to pipeline named weatherapianalysis
Run Pipeline
Show Pipeline Step to verify if it succeeded or failed

Screenshots

<details> <summary>Click here to show the screenshots of project</summary> Figure 1 <img src ="screenshots/screenshot_1.PNG"> Figure 2 <img src ="screenshots/screenshot_2.PNG"> Figure 3 <img src ="screenshots/screenshot_3.PNG"> Figure 4 <img src ="screenshots/screenshot_4.PNG"> Figure 5 <img src ="screenshots/screenshot_5.PNG"> Figure 6 <img src ="screenshots/screenshot_6.PNG"> Figure 7 <img src ="screenshots/swagger.PNG"> Figure 8 <img src ="screenshots/jacoco.PNG"> Figure 9 <img src ="screenshots/prometheus_docker.PNG"> Figure 10 <img src ="screenshots/grafana_docker_1.PNG"> Figure 11 <img src ="screenshots/grafana_docker_2.PNG"> Figure 12 <img src ="screenshots/grafana_docker_3.PNG"> Figure 13 <img src ="screenshots/grafana_docker_4.PNG"> Figure 14 <img src ="screenshots/grafana_docker_5.PNG"> Figure 15 <img src ="screenshots/docker_sonarqube.PNG"> Figure 16 <img src ="screenshots/kubernetes_1.PNG"> Figure 17 <img src ="screenshots/kubernetes_2.PNG"> Figure 18 <img src ="screenshots/kubernetes_3.PNG"> Figure 19 <img src ="screenshots/kubernetes_prometheus.PNG"> Figure 20 <img src ="screenshots/kubernetes_grafana_1.PNG"> Figure 21 <img src ="screenshots/kubernetes_grafana_2.PNG"> Figure 22 <img src ="screenshots/kubernetes_grafana_3.PNG"> Figure 23 <img src ="screenshots/kubernetes_grafana_4.PNG"> Figure 24 <img src ="screenshots/kubernetes_grafana_5.PNG"> Figure 25 <img src ="screenshots/kubernetes_sonarqube_1.PNG"> Figure 26 <img src ="screenshots/kubernetes_sonarqube_2.PNG"> Figure 27 <img src ="screenshots/kubernetes_sonarqube_3.PNG"> Figure 28 <img src ="screenshots/kubernetes_sonarqube_4.PNG"> Figure 29 <img src ="screenshots/kubernetes_sonarqube_5.PNG"> Figure 30 <img src ="screenshots

Weatherapianalysis

Install / Use

README

Case Study - Weather Api Analysis Api

📖 Information

Explore Rest APIs

Technologies

Postman

Prerequisites

Define Variable in .env file

Open Api (Swagger)

JaCoCo (Test Report)

Maven, Docker and Kubernetes Running Process

Maven Run

Docker Run

Kubernetes Run

Docker Image Location

Sonarqube

Jenkins

Screenshots