https://github.com/eliasnogueira/credit-api
Combined API to simulate a credit request (in a Brazilian way!)
https://github.com/eliasnogueira/credit-api
Last synced: 7 months ago
JSON representation
Combined API to simulate a credit request (in a Brazilian way!)
- Host: GitHub
- URL: https://github.com/eliasnogueira/credit-api
- Owner: eliasnogueira
- License: mit
- Created: 2020-02-09T14:27:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T04:28:12.000Z (7 months ago)
- Last Synced: 2025-03-17T23:51:55.916Z (7 months ago)
- Language: Java
- Homepage: http://eliasnogueira.com
- Size: 396 KB
- Stars: 12
- Watchers: 2
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Combined Credit API
[](https://github.com/eliasnogueira/credit-api/actions/workflows/merge-main.yml)
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](https://github.com/eliasnogueira/credit-restriction-api)
* [credit-simulation-api](https://github.com/eliasnogueira/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 ``.
Changing the port running the application using the jar file
```shell
java -jar credit-api-VERSION.jar --server-port=8089
```
Changing the port running the application using mvn
```shell
./mvnw spring-boot:run -Dspring-boot.run.arguments=--server.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](CONTRIBUTING.md)