Skip to content

Latest commit

 

History

History
334 lines (187 loc) · 11.1 KB

README.md

File metadata and controls

334 lines (187 loc) · 11.1 KB
Raw

Online-Retail-Store

A popular online retail store wish to automate their business and decided to follow Domain drive design approach which involves collaboration with Business & Development teams. As part of the design, various subdomains are identified and "OrderService" is classified as core subdomain as this is their business differentiator & earns them the revenue. In this subdomain they have identified various bounded contexts as mentioned below:

  • Customer: Customer is the user of this subdomain. In order to segregate the responsibilities of Customer a separate bounded context is maintained that captures information about the customer. The Domain model of the customer is as depicted below:

API description:

| HttpMethod | MethodName

| Input parameter | Description

| Response

| | --- | --- | --- | --- | --- | | POST | /api/addCustomer/

| Customer details | Creates a new customer with billing & shipping details. Customer id to be auto-generated | 201 | | DELETE | /api/deleteteCustomer/

| customerld

| Deletes the Customer with the given id | 200 | | PUT | /api/updateCustomer/

| customerid & new customer detals in POST request

| Updates the customer with given customer id with new details | 200 | | GET | /api/searchCustomer/

| customerid

| Returns the customer details for the customerid | 200 |

  • Products: The attributes of the products which helps Customer to search & purchase the product is maintained as part of "Products Catalogue" bounded context. A customer would search for products in Products Catalogue. The Domain model for this bounded context is as shown below:

API description:

| HttpMethod | MethodName

| Input parameter | Description

| Response

| | --- | --- | --- | --- | --- | | POST | /api/products/

| Input: Product details. This api should be mapped to addProduct method | Creates a new Product and product id should be auto-generated | 201 | | DELETE | /api/products/{id}

| Input: productId. This should be mapped to deleteProduct() method

| Deletes the Product with the given id | 200 | | PUT | /api/products/{id}

| Input: productId and new product details This should be mapped to updateProduct() method

| Updates the Product with given product id with new details | 200 | | GET | /api/products/{id}

| Input: productId. This should be mapped to getProduct() method

| Returns the Product details for the productid | 200 |

  • Inventory: This Microservice maintains the inventory information of the product which needs frequent updation. Here we would maintain only quantity corresponding to the product. Domain model is as represented below:

API Specification:

| HttpMethod | MethodName

| Input parameter | Description

| Response

| | --- | --- | --- | --- | --- | | POST |

/api/inventory

| Input: Product details (product id & quantity) This api should be mapped to addInventorymethod

| Creates a new inventory (product id & quantity) and inventory id should be auto-generated | 201 | | DELETE | /api/inventory/{id}

| Input: productid. This should be mapped to deleteInventory() method

| Deletes the Inventory with the given id | 200 | | PUT |

/api/inventory/{id}

| Input: productId and new productdetails This should be mapped to updateInventory() method | Updates the Inventory with new details | 200 | | GET | /api/inventory/{id}

| Input: productid. This should be mapped to getInventory() method

| Returns the Inventory details for the productid | 200 |

  • Cart: This Microservice represents the Shopping cart of the customer. This contains set of products customer has selected to purchase. Please note there should be only one cart for the customer and this cart should be made empty upon placing order for the products in the cart. Domain Model for the cart is as shown below:

Please note we should maintain One-to-Many relationship between Cart & Line Item.

API Specification:

| HttpMethod | MethodName

| Input parameter | Description

| Response

| | --- | --- | --- | --- | --- | | POST |

/api/cart

| Input: Cart Details that can contain one or more line items This api should be mapped to addCart method

| Creates a new cart item for the customer with one or more products Cart id to be auto-generated | 201 | | DELETE | /api/cart/{id}

| Input: cartid. This should be mapped to emptyCart() method

| Deletes the cart with the given id | 200 | | PUT |

/api/cart/{id}

| Input: cartid and cart details is passed as Request body. This should be mapped to updateCart() method | Updates the cart with new cart details for a given cartid | 200 | | GET | /api/cart/{id}

| Input: cartid. This should be mapped to searchCart() method

| Returns the cart details for the cartid | 200 |

  • Order: Customer can place order for all the items selected in the cart and Order Micro service is responsible for this functionality. Customer can place an order, view all his orders using this microservice. The Domain model is as shown below.

API Specification:

| HttpMethod | MethodName

| Input parameter | Description

| Response

| | --- | --- | --- | --- | --- | | POST |

/api/order | Input: Order Details that can contain one or more line itemsThis api should be mapped to addOrder method

| Creates a new order for the customer with one or more products order id to be auto-generated | 201 | | DELETE | /api/order/{id}

| Input: orderid. This should be mapped to deleteOrder() method

| Deletes the order with the given id | 200 | | PUT |

/api/order/{id}

| Input: orderid and cart details is passed as Request body. This should be mapped to updateOrder() method | Updates the order with new order details for a given order id | 200 | | GET | /api/order/{id}

| Input: orderid. This should be mapped to searchOrder() method

| Returns the order details for the order id | 200 |

  • API Gateway and Composite Microservice: Above mentioned 5 business microservices should be abstracted from External world by API Gateway. In this case we would follow a variant of Database Aggregation pattern. Content Aggregation would be done by a composite microservice (ShoppingService) API Gateway exposes below APIs to the external world.
  1. POST** /api/shoppingservice/products**

This API is used by external client to create a product

  • API gateway would route the request to Composite Microservice
  • Composite Microservice would invoke Product Microservice to create a product
  • Composite Microservice would invoke Inventory Microservice with productid generated from previous call & updates the inventory information

Sample Request:

{

"productName": "Samsung Galaxy",

"productDescription": "Samsung Mobile",

"productPrice": "10000".

"quantity": "5"

}

  1. POST** /api/shippingservice/customer**

This API is used by external client to create a customer

  • API gateway would route the request to Composite Microservice
  • Composite Microservice would invoke Customer Microservice to create a Customer
  • Composite Microservice would invoke Cart Microservice to create an empty cart for new customer
  • Composite Microservice would receive customerId and cartId from above calls and mapping between Customer and Cart is maintained in Customer-Cart Table
customerId cartId
1001 102
1002 103

Sample Request:

{

" customerName": "Suresh",

"customerEmail": " suresh.kumar@wipro.com ",

"customerBilling Address": [

{

"doorNo": "312",

"streetName": "Raman Street",

"layout": "Gandhi Nagar",

"city": "Bangalore",

"pincode": "560004"

}

],

"customerShipping Address": [

{

"doorNo": "312",

"streetName": "Raman Street",

"layout":"Gandhi Nagar".

"city": "Bangalore",

"pincode": "560004"

}

]

}

  1. PUT** /api/shippingservice/customer/{customerid}/cart**

This API is used by external client to add products to the cart. This can be invoked multiple times to add different products to the cart

  • API gateway would route the request to Composite Microservice
  • Composite Microservice would check Customer-Cart" table to check if the customer with the customerid passed in the request exists & and fetches the cartid for the customer
  • Composite Microservice would invoke cart microservice to add the products to the cart

Sample Request:

{

"LineItems":[

{

" productId":"1001",

" productName":"Samsung Galaxy",

" quantity":"1"

},

{

" productId":"1002",

" productName":"LG refrigerator",

" quantity":"1"

}

]

}

  1. POST** /api/shoppingservice/customer/{customerid}/order**

This API is used by external client to place order.

  • API gateway would route the request to Composite Microservice
  • Composite Microservice would check "Customer-Cart" table to check if the customer with the customerld passed in the request exists & and fetches the cartid for the customer.
  • Composite Microservice would invoke order microservice and pass all the line items present in the cart.
  • Composite microservice to invoke API to empty Cart once order placement is successful so that no duplicate order could be created.
  • Composite microservice would invoke inventory microservice to update the inventory of products for which order is placed.
  • Composite Microservice would maintain mapping between Customerid & Orderid generated from placing the order in Customer-Order table.

Sample data is as shown below:

customerId orderId
1001 5001
1001 5002

Here Customer 1001 has 2 orders: 5001, 5002

Sample Request:

No Request body is sent. Composite microservice should get the products from Cart.

  1. GET /api/shippingservice/customer/{customerid}/orders

This API is used by external client to view all orders placed by customer.

  • API gateway would route the request to Composite Microservice
  • Composite Microservice would check "Customer-Order" table to check if the customer with the customerid passed in the request exists & and fetches the orderids for the customer
  • Composite microservice would invoke Customer Service to get the customer details for the customer Id passed in the request. It then invokes Order Service to get all the orders for the customer. Composite Microservice would aggregate both the responses and send the final response to the client

In addition to the Microservices explained, Discoveryserver, Configuration server & Hystrix should also be implemented & demonstrated.

Author: Jatin Batra