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
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
[x] A /api/health endpoint is added to the currency converter API.
[x] The health check endpoint returns a status indicating the health of the API.
[x] The endpoint response includes relevant information such as server uptime, database status, etc.
[ ] Add Unit Tests for Endpoint and Related Services/Utilities
[x] Logger is configured to log relevant information for the health check endpoint.
[ ] Postman collection is provided for testing the /api/health endpoint.
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
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
/api/health
endpoint is added to the currency converter API./api/health
endpoint.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