# hoangtien2k3/ecommerce-microservices architecture

> Architecture diagram of the GitHub repository hoangtien2k3/ecommerce-microservices, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hoangtien2k3/ecommerce-microservices
- Repository: https://github.com/hoangtien2k3/ecommerce-microservices

## Overview

##### Main Components
- API Gateway – Acts as the entry point into the microservice ecosystem.
- Discovery Service – Provides service registration and discovery, enabling dynamic routing between services.
- Common Library (common-lib) – A shared reusable module that contains common constants, exception handlers, Kafka configurations, CSV utilities, mappers, etc., which many services depend on.
- External Systems – Include supporting components such as:
– Database systems (MySQL/other databases, as referenced in each service’s resources and Liquibase changelogs).
– Kafka (for message sending and consumption) along with Zookeeper/Broker.
– Docker and Docker Compose which are used to containerize and orchestrate these services.
– Distributed tracing tools (Zipkin, as indicated by the zipkin files) for monitoring interservice communications.
– API Documentation (Swagger) visible in several services for automated API docs.

- The API Gateway receives incoming client requests (from web or mobile apps) and routes them to the appropriate microservices.

##### Architectural Patterns and Technologies
- Microservices – Emphasize the decoupled architecture where each service is a standalone Spring Boot application.
- Database Per Service – Each service typically has its own database connection (document migrations with Liquibase in services like inventory-service, product-service, etc.).
- Shared Library – Show that services reference the common-lib for shared functionality (exception handling, configuration, messaging, etc.).
- Reactive Programming – Note that many services use WebFlux/Reactive programming (e.g., Reactor) for handling reactive streams if needed.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Clients["External Clients"]:::client
    API_Gateway["API Gateway – Entry Point"]:::service
    Discovery["Discovery Service"]:::service

    Clients -->|"requests"| API_Gateway
    API_Gateway -->|"routesTo"| Discovery

    subgraph "Microservices"
        Favourite["Favourite Service"]:::service
        Inventory["Inventory Service"]:::service
        Media["Media Service"]:::service
        Notification["Notification Service"]:::service
        Order["Order Service"]:::service
        Payment["Payment Service"]:::service
        Product["Product Service"]:::service
        Promotion["Promotion Service"]:::service
        Rating["Rating Service"]:::service
        Search["Search Service"]:::service
        Shipping["Shipping Service"]:::service
        Tax["Tax Service"]:::service
        User["User Service"]:::service
    end

    %% API Gateway to Microservices
    API_Gateway -->|"toFavourite"| Favourite
    API_Gateway -->|"toInventory"| Inventory
    API_Gateway -->|"toMedia"| Media
    API_Gateway -->|"toNotification"| Notification
    API_Gateway -->|"toOrder"| Order
    API_Gateway -->|"toPayment"| Payment
    API_Gateway -->|"toProduct"| Product
    API_Gateway -->|"toPromotion"| Promotion
    API_Gateway -->|"toRating"| Rating
    API_Gateway -->|"toSearch"| Search
    API_Gateway -->|"toShipping"| Shipping
    API_Gateway -->|"toUser"| User

    %% Discovery Service interactions with Microservices
    Discovery ---|"discovers"| Favourite
    Discovery ---|"discovers"| Inventory
    Discovery ---|"discovers"| Media
    Discovery ---|"discovers"| Notification
    Discovery ---|"discovers"| Order
    Discovery ---|"discovers"| Payment
    Discovery ---|"discovers"| Product
    Discovery ---|"discovers"| Promotion
    Discovery ---|"discovers"| Rating
    Discovery ---|"discovers"| Search
    Discovery ---|"discovers"| Shipping
    Discovery ---|"discovers"| Tax
    Discovery ---|"discovers"| User

    %% Databases Subgraph
    subgraph "Databases"
        Favourite_DB["Favourite DB"]:::database
        Inventory_DB["Inventory DB"]:::database
        Media_DB["Media DB"]:::database
        Notification_DB["Notification DB"]:::database
        Order_DB["Order DB"]:::database
        Payment_DB["Payment DB"]:::database
        Product_DB["Product DB"]:::database
        Promotion_DB["Promotion DB"]:::database
        Rating_DB["Rating DB"]:::database
        Search_DB["Search DB"]:::database
        Shipping_DB["Shipping DB"]:::database
        Tax_DB["Tax DB"]:::database
        User_DB["User DB"]:::database
    end

    %% Each Microservice uses its own DB
    Favourite -->|"usesDB"| Favourite_DB
    Inventory -->|"usesDB"| Inventory_DB
    Media -->|"usesDB"| Media_DB
    Notification -->|"usesDB"| Notification_DB
    Order -->|"usesDB"| Order_DB
    Payment -->|"usesDB"| Payment_DB
    Product -->|"usesDB"| Product_DB
    Promotion -->|"usesDB"| Promotion_DB
    Rating -->|"usesDB"| Rating_DB
    Search -->|"usesDB"| Search_DB
    Shipping -->|"usesDB"| Shipping_DB
    Tax -->|"usesDB"| Tax_DB
    User -->|"usesDB"| User_DB

    %% Asynchronous Messaging with Kafka Cluster
    Kafka["Kafka Cluster"]:::integration
    Notification ---|"messaging"| Kafka
    Payment ---|"messaging"| Kafka
    Order ---|"messaging"| Kafka

    %% Shared Common Library usage
    Common_Lib["Common Library"]:::common
    Favourite -->|"dependsOn"| Common_Lib
    Inventory -->|"dependsOn"| Common_Lib
    Media -->|"dependsOn"| Common_Lib
    Notification -->|"dependsOn"| Common_Lib
    Order -->|"dependsOn"| Common_Lib
    Payment -->|"dependsOn"| Common_Lib
    Product -->|"dependsOn"| Common_Lib
    Promotion -->|"dependsOn"| Common_Lib
    Rating -->|"dependsOn"| Common_Lib
    Search -->|"dependsOn"| Common_Lib
    Shipping -->|"dependsOn"| Common_Lib
    Tax -->|"dependsOn"| Common_Lib
    User -->|"dependsOn"| Common_Lib
    API_Gateway -->|"dependsOn"| Common_Lib
    Discovery -->|"dependsOn"| Common_Lib

    %% Liquibase-based Database Migration for selected services
    Liquibase["Liquibase Migration"]:::integration
    Inventory ---|"migrations"| Liquibase
    Media ---|"migrations"| Liquibase
    Promotion ---|"migrations"| Liquibase
    Tax ---|"migrations"| Liquibase

    %% Distributed Tracing with Zipkin
    Zipkin["Zipkin Tracing"]:::integration
    API_Gateway ---|"traces"| Zipkin
    Discovery ---|"traces"| Zipkin
    Favourite ---|"traces"| Zipkin
    Inventory ---|"traces"| Zipkin
    Media ---|"traces"| Zipkin
    Notification ---|"traces"| Zipkin
    Order ---|"traces"| Zipkin
    Payment ---|"traces"| Zipkin
    Product ---|"traces"| Zipkin
    Promotion ---|"traces"| Zipkin
    Rating ---|"traces"| Zipkin
    Search ---|"traces"| Zipkin
    Shipping ---|"traces"| Zipkin
    Tax ---|"traces"| Zipkin
    User ---|"traces"| Zipkin

    %% Docker-based Deployment for containerization
    Docker["Docker Deployment"]:::integration
    API_Gateway ---|"dockerBuild"| Docker
    Discovery ---|"dockerBuild"| Docker
    Favourite ---|"dockerBuild"| Docker
    Inventory ---|"dockerBuild"| Docker
    Media ---|"dockerBuild"| Docker
    Notification ---|"dockerBuild"| Docker
    Order ---|"dockerBuild"| Docker
    Payment ---|"dockerBuild"| Docker
    Product ---|"dockerBuild"| Docker
    Promotion ---|"dockerBuild"| Docker
    Rating ---|"dockerBuild"| Docker
    Search ---|"dockerBuild"| Docker
    Shipping ---|"dockerBuild"| Docker
    Tax ---|"dockerBuild"| Docker
    User ---|"dockerBuild"| Docker

    %% Click Events for component mapping
    click API_Gateway "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/api-gateway/"
    click Discovery "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/discovery-service/"
    click Favourite "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/favourite-service/"
    click Inventory "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/inventory-service/"
    click Media "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/media-service/"
    click Notification "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/notification-service/"
    click Order "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/order-service/"
    click Payment "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/payment-service/"
    click Product "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/product-service/"
    click Promotion "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/promotion-service/"
    click Rating "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/rating-service/"
    click Search "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/search-service/"
    click Shipping "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/shipping-service/"
    click Tax "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/tax-service/"
    click User "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/user-service/"
    click Common_Lib "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/common-lib/"
    click Docker "https://github.com/hoangtien2k3/ecommerce-microservices/blob/main/docker-compose.yml"
    click Kafka "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/common-lib/src/main/java/com/hoangtien2k3/commonlib/kafka/"
    click Liquibase "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/inventory-service/src/main/resources/db/changelog/"
    click Zipkin "https://github.com/hoangtien2k3/ecommerce-microservices/tree/main/zipkin-distributed-tracing/"

    %% Style definitions
    classDef client fill:#ffdd99,stroke:#cc6600,stroke-width:2px;
    classDef service fill:#add8e6,stroke:#3333ff,stroke-width:2px;
    classDef database fill:#ccffcc,stroke:#009900,stroke-width:2px;
    classDef common fill:#e6ccff,stroke:#6600cc,stroke-width:2px;
    classDef integration fill:#ffe6e6,stroke:#ff0000,stroke-width:2px;
```
