Welcome to the Shippings System App!
- Mule 4.6.1 EE
- MySQL database
- H2 database
- Java 8
- Maven 3.9.6
Applicaiton connects to the remote database by using the secured credentials.
To be able to run the application you have to provide your own credentials (host, port, username, password) and encrypt them.
In order to achieve that, please follow instructions on this link: https://docs.mulesoft.com/mule-runtime/latest/secure-configuration-properties
Application is developed to load property files based on the development environment you are working on.
To be able to run the application, you have to provide environemnt information and encryption key:
- VM argumens to run the application are: -M-Dmule-env=dev -M-Dencryption.key=YOUR_KEY_HERE
- VM argumens to run the MUnit tests are: -Dmule-env=qa -Dencryption.key=YOUR_KEY_HERE
If you need some help, please follow instructions on this link: https://docs.mulesoft.com/mule-runtime/latest/deploying-to-multiple-environments
Application is developed using the Anypoint Studio 7.17, with it's embedded Maven and JDK.
The easiest way to run the application is to download Anypoint Studio and import application as "Anypoint Studio project from File System".
If you don't want to use Anypoint Studio, you can run the application using the mule CLI.
Here are the instructions how to configure Mule Standalone Runtime on your machine and run the application: https://docs.mulesoft.com/mule-runtime/latest/mule-standalone
By default, application will run on http://localhost:8081
Following endpoints will be exposed:
| Methods | Urls | Actions |
|---|---|---|
| GET | /shippings/console | API Console, opens generated documentation |
| GET | /api/shippings | Retrieve all shippings. |
| GET | /api/shippings?name=[keyword]&match=[keyword] | Retrieve all shippings using the optional query parameters |
| POST | /api/shippings | Create a new shipping |
| GET | /api/shippings/{id} | Get shipping specified by it's unique ID |
| PUT | /api/shippings/{id} | Update shipping specified by it's unique ID |
| DELETE | /api/shippings/{id} | Delete shipping specified by it's unique ID |
To test the appliactions endpoints you can use API Console.
Provides intuitive way to see what data endpoints are expecting, so as what are they returning.
Feel free to explore the application and use the provided examples to understand how to interact with each endpoint. If you have any questions or issues, please refer to the API documentation or contact the application maintainers.
