For Open API (Swagger) Documentation UI and the endpoints, open http://localhost:8080/swagger-ui/index.html after running the app.
The Postman Collection shared in the resources can be modified and used for testing the endpoints.
Note
All URIs are relative to http://localhost:8080/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthController | login | POST /auth/login | Authenticates users by their credentials |
| AuthController | signup | POST /auth/signup | Registers users using their credentials and user info |
| Class | Method | HTTP request | Description |
|---|---|---|---|
| WalletController | findById | GET /wallets/{id} | Retrieves a single wallet by the given id |
| WalletController | findByIban | GET /wallets/iban/{iban} | Retrieves a single wallet by the given iban |
| WalletController | findAllByUserId | GET /wallets/users/{userId} | Retrieves all wallets based on the given userId |
| WalletController | findAll | GET /wallets?page=0&size=10&sort=id,asc | Retrieves all wallets based on the given parameters |
| WalletController | create | POST /wallets | Creates a new wallet using the given request parameters |
| WalletController | transferFunds | POST /wallets/transfer | Transfer funds between wallets |
| WalletController | addFunds | POST /wallets/addFunds | Adds funds to the given wallet of the user |
| WalletController | withdrawFunds | POST /wallets/withdrawFunds | Withdraws funds from the given wallet of the user |
| WalletController | update | PUT /wallets | Updates wallet using the given request parameters |
| WalletController | deleteById | DELETE /wallets | Deletes wallet by id |
| Class | Method | HTTP request | Description |
|---|---|---|---|
| TransactionController | findById | GET /transactions/{id} | Retrieves a single transaction by the given id |
| TransactionController | findByReferenceNumber | GET /transactions/references/{referenceNumber} | Retrieves a single transaction by the given reference number |
| TransactionController | findAllByUserId | GET /transactions/users/{userId} | Retrieves all transactions based on the given userId |
| TransactionController | findAll | GET /transactions?page=0&size=10&sort=id,asc | Retrieves all transactions based on the given parameters |
Unit and Integration Tests will be provided for services and controllers in the corresponding packages.