Combined Credit API

This project was created to start the initial steps with test automation for a REST API using RestAssured. It's a combination of the following projects to facilitate the test automation:

• credit-restriction-api
• credit-simulation-api

Required software

• Java JDK 23+
  • you can change the java.version property in the pom.xml file to 17 as this project is not using any specific Java 23 feature

About the API

How to start the API

First, clone or download this project. After:

1. Navigate to the project folder using the Terminal / Command prompt
2. Execute the following: ./mvnw spring-boot:run
3. Wait until you see something like this: Application has started! Happy tests!

How to change the port

The default port is 8088. If you want to change the port to another one, execute the following command, replacing the text <NEW_PORT>.

Changing the port running the application using the jar file

java -jar credit-api-VERSION.jar --server-port=8089

Changing the port running the application using mvn

./mvnw  spring-boot:run -Dspring-boot.run.arguments=--server.port=<NEW_PORT>

How to access the documentation (Swagger)

After the application has started open the link: http://localhost:8088/swagger-ui.html

Do you want to help?

Please read the Contribution guide