Exchange API is a RESTful API providing exchange rates and conversions for many currencies.

1. Technologies
2. Running
3. Configuration
4. Documentation
5. Development and Testing
6. Contributing
7. License

Exchange API is a Spring Boot project written in Java 11 and it uses following:

• fixer.io as exchange rate provider
• Spring Data for data persistence
• H2 as database
• e for error management
• Spring Doc for API documentation
• JUnit 5 and HttpClientMock for testing
• Gradle as build tool

You can Exchange API as a regular Java application in your favorite IDE with Main.java as your main class. You can also run it with Gradle as following:

gradle bootRun

By default, Exchange API runs on localhost:8080.

There is also a playground deployed on Heroku at https://akifs-exchange-api.herokuapp.com. Feel free to visit https://akifs-exchange-api.herokuapp.com/swagger.html and play with it.

There is no need for a manual configuration as default values are enough to run Exchange API out-of-the-box. However, if you wish to make your own configuration (change credentials etc.), you can do so by editing application.properties file.

API documentation is managed by Spring Doc. To access Swagger UI, open /swagger.html in a web browser after running Exchange API. You can also find Open API specification at /docs as a Json.

Exchange API is built with Gradle. You can use regular Gradle tasks such as clean, compile, test tasks for development and testing.

All contributions are welcome, including requests to feature your project utilizing Exchange API. Please feel free to send a pull request. Thank you.

Exchange API is licensed with MIT License.