Skip to content

makiftutuncu/exchange

Repository files navigation

Exchange API

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

Table of Contents

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

Technologies

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

Running

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.

Configuration

Exchange API can run out-of-the-box as long as credentials for rate provider is defined as FIXER_IO_KEY environment variable or in application.yml file.

Documentation

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.

Development and Testing

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

Contributing

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

License

Exchange API is licensed with MIT License.