#590 explanation for Aggregator Microservices

aggregator-microservices/README.md

@@ -10,16 +10,91 @@ tags:
 
 ## Intent
 
-The user makes a single call to the Aggregator, and the aggregator then calls each relevant microservice and collects
+The user makes a single call to the aggregator service, and the aggregator then calls each relevant microservice.
-the data, apply business logic to it, and further publish is as a REST Endpoint.
+
-More variations of the aggregator are: 
+## Explanation
-- Proxy Microservice Design Pattern: A different microservice is called upon the business need. 
+
-- Chained Microservice Design Pattern: In this case each microservice is dependent/ chained to a series 
+Real world example
-of other microservices.
+
+> Our web marketplace needs information about products and their current inventory. It makes a call to an aggregator
+> service that in turn calls the product information microservice and product inventory microservice returning the
+> combined information. 
+
+In plain words
+
+> Aggregator Microservice collects pieces of data from various microservices and returns an aggregate for processing. 
+
+Stack Overflow says
+
+> Aggregator Microservice invokes multiple services to achieve the functionality required by the application.
+
+**Programmatic Example**
+
+Let's start from the data model. Here's our `Product`.
+
+```java
+public class Product {
+  private String title;
+  private int productInventories;
+  // getters and setters ->
+  ...
+}
+```
+
+Next we can introduct our `Aggregator` microservice. It contains clients `ProductInformationClient` and
+`ProductInventoryClient` for calling respective microservices.
+
+```java
+@RestController
+public class Aggregator {
+
+  @Resource
+  private ProductInformationClient informationClient;
+
+  @Resource
+  private ProductInventoryClient inventoryClient;
+
+  @RequestMapping(path = "/product", method = RequestMethod.GET)
+  public Product getProduct() {
+
+    var product = new Product();
+    var productTitle = informationClient.getProductTitle();
+    var productInventory = inventoryClient.getProductInventories();
+
+    //Fallback to error message
+    product.setTitle(requireNonNullElse(productTitle, "Error: Fetching Product Title Failed"));
+
+    //Fallback to default error inventory
+    product.setProductInventories(requireNonNullElse(productInventory, -1));
+
+    return product;
+  }
+}
+```
+
+Here's the essence of information microservice implementation. Inventory microservice is similar, it just returns
+inventory counts.
+
+```java
+@RestController
+public class InformationController {
+  @RequestMapping(value = "/information", method = RequestMethod.GET)
+  public String getProductTitle() {
+    return "The Product Title.";
+  }
+}
+```
+
+Now calling our `Aggregator` REST API returns the product information.
+
+```bash
+curl http://localhost:50004/product
+{"title":"The Product Title.","productInventories":5}
+```
 
 ## Class diagram
 
-![alt text](./etc/aggregator-microservice.png "Aggregator Microservice")
+![alt text](./etc/aggregator-service.png "Aggregator Microservice")
 
 ## Applicability
 
@@ -28,3 +103,5 @@ Use the Aggregator Microservices pattern when you need a unified API for various
 ## Credits
 
 * [Microservice Design Patterns](http://web.archive.org/web/20190705163602/http://blog.arungupta.me/microservice-design-patterns/)
+* [Microservices Patterns: With examples in Java](https://www.amazon.com/gp/product/1617294543/ref=as_li_qf_asin_il_tl?ie=UTF8&tag=javadesignpat-20&creative=9325&linkCode=as2&creativeASIN=1617294543&linkId=8b4e570267bc5fb8b8189917b461dc60)
+* [Architectural Patterns: Uncover essential patterns in the most indispensable realm of enterprise architecture](https://www.amazon.com/gp/product/B077T7V8RC/ref=as_li_qf_asin_il_tl?ie=UTF8&tag=javadesignpat-20&creative=9325&linkCode=as2&creativeASIN=B077T7V8RC&linkId=c34d204bfe1b277914b420189f09c1a4)