This is the Quick Start tutorial that utilizes the pre-built repository to provide an introduction to MS Chain Services.
If you prefer to do a step-by-step setup of MS Chain Services please visit the MS Chain Services Home
You will need the following dependencies before starting this tutorial:
Java JDK 8 (I prefer OpenJDK but Oracle JDK will do)
This quick start tutorial is designed for anyone beginning to utilize Light-4j and wants to gain a general understanding of how to setup a microservice chain application utilizing four APIs. This example found in light-example-4j/rest/swagger/ms_chain shows four APIs being utilized as such:
API A -> API B, API B -> API C, API C -> API D
Setting up the Environment
You are able to utlized two methods in order to build the pom.xml. One method shown below is how to run all four APIs within IntelliJ IDEA through the application solely. In order to gain a deeper look into this demonstration, it is recommended to attempt it through the command line.
Utilizing IntelliJ IDEA
After cloning the above git repository, the ms_chain directory must be opened and in order to correctly run Maven, we must go into the directory containing the pom.xml file (/rest/swagger/ms_chain/api_a/httpschain) and option click>“Add as Maven Project”. This will create a classpath of module which should be selected in IntelliJ’s “Edit Configurations”.
Once we have our environment set up, we can begin to test it and see if API A will call the other three APIs.
Utilizing Command Line
In order to run the Microservices Chain Pattern we must finally execute all APIs (A, B, C, and D) onto their ports. The example sets up the ports 7441, 7442, 7443, and 7444, respectively. Within the separate API folder directories (E.g. api_a/httpschain) run the Maven command to run the API on the port:
mvn install exec:exec
If you do not specify where your pom.xml file is, we must run the maven command from the directory it is in. In this example it is in api_a/httpschain.
Also note that our api_a/generated does not include the chain services code, but is simply the “blueprint” of our APIs.
Regardless of the platform you used to build the pom.xml after the completion of many tests, the output for running API A should be :
Http Server started on ip:0.0.0.0 Port:7441
Https Server started on ip:0.0.0.0 Port:7441
Run this three more times for APIs B, C, and D. Do not forget to “Add As Maven Project“ for the remaining APIs if you are utilizing IntelliJ and utilizing “mvn install exec:exec“ in separate terminal windows if using the command line. The output, excluding port numbers, should be the same.
If you come across an error when initializing a port, visit your server.yml file in each directory (A, B, C, and D) and change the *Httpsport” number to a unique port currently not in use OR ensure the port is not already in use.
Note: each API must have a separate port number.
Once this is completed separately for all four APIs, you can begin execution and testing. Open a new shell and execute the following command.
curl -k https://localhost:7441/v1/data
What is curl? Curl simply sends a request. In the command line, the curl command is entered with the option -k as it allows curl to proceed and operate even for server connections otherwise considered insecure. Furthermore, we input port 7441 for API A. Our /v1/data is our GET Handler from our PathHandlerProvider.java.
The remaining 3 API files also append their strings, and the final output returns the list.
In order to understand the differences between these four entities, explore the PathHandlerProvider.java in the respective directories (api_x/httpschain). API A holds more connection establishment calls and checks than API D.
Attempt Other Handlers
Other handlers can be found in PathHandlerProvider.java and utilized in the same way as our initial curl for example:
curl -k https://localhost:7441/v1/health
and will output:
In this tutorial, a Microservice Chain Pattern application was implemented locally with general understanding of the difference between our generated directory and our httpschain directory, and their differing uses. It is also recommended to strengthen your understanding by creating your own system using Light-4j