rajeshsinha1997 / currency-converter-api

The Currency Converter API allows users to convert amounts from one currency to another. It provides a simple and efficient way to perform currency conversions using the latest exchange rates.
MIT License
0 stars 0 forks source link

API Health Endpoint Implementation - GET - /api/health #1

Open rajeshsinha1997 opened 5 months ago

rajeshsinha1997 commented 5 months ago

Description

As a user of the currency converter API, I would like to have a /api/health endpoint added to the API so that I can easily check the health and status of the API. Additionally, I request configuration for logger and a Postman collection for testing purposes.

Acceptance Criteria

Additional Information

Currently, there's no straightforward way to check the health of the currency converter API. Having a dedicated health check endpoint will greatly improve the observability and reliability of the API, allowing users to quickly determine if the API is functioning properly or if there are any issues that need to be addressed.

Configuring a logger will ensure that relevant information about the health check endpoint is logged, aiding in debugging and monitoring.

A Postman collection will provide a convenient way for users to test the /api/health endpoint and verify its functionality.

The currency converter API is built using Spring Boot, and the source code is available in the following GitHub repository: Currency Converter API GitHub Repository

rajeshsinha1997 commented 5 months ago

I'll be working on this issue.