# trantranloc/spring-ecommerce-api architecture

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

- Interactive diagram: https://gitdiagram.com/trantranloc/spring-ecommerce-api
- Repository: https://github.com/trantranloc/spring-ecommerce-api

## Overview

##### Main Components Identification

a. API Layer (Controllers)
- Authentication endpoints
- Product management
- Cart operations
- Category management
- User management

b. Service Layer
- Business logic implementation
- Transaction management
- Service-to-service communication

c. Repository Layer
- Data access objects
- Database interactions

d. Security Layer
- JWT authentication
- Role-based access control
- Security configurations

e. Database
- PostgreSQL/MySQL storage
- Entity relationships

##### Component Relationships

a. External Interface:
- API Gateway/Controllers at the top
- Swagger/OpenAPI documentation interface
- Security filter chain

b. Core Services (Middle Layer):
- UserService
- ProductService
- CartService
- CategoryService
- Clear separation between services

c. Data Layer:
- Repositories at the bottom
- Database connection
- Entity relationships

##### Specific Design Elements

Use these symbols and conventions:
- Rectangles: Components and services
- Hexagons: External interfaces/APIs
- Blue: API/Controller layer
- Green: Service layer
- Yellow: Repository layer
- Red: Security components
- Gray: External systems/databases

##### Detailed Component Breakdown

a. Security Layer:
**SecurityConfig (JWT Filter) → Authentication Controller → UserService → UserRepository**

b. Core Business Flow:
**Controller → Service → Repository → Database**

c. Cross-cutting Concerns:
- Exception Handling (GlobalExceptionHandler)
- Configuration (JpaConfig, SwaggerConfig)
- Model mappings

##### Key Relationships to Highlight

a. Entity Relationships:
- User → Cart → CartItem → Product
- Product → Category
- User → Role

b. Service Dependencies:
- CartService → ProductService
- UserService → RoleService
- ProductService → CategoryService

##### Technical Details

- JWT authentication flow
- Database transaction boundaries
- Swagger/OpenAPI integration
- Error handling flow
- Security filter chain

##### Database

Left to Right Organization:
- Related components (e.g., Product-related components together)
- Cross-cutting concerns on the sides
- Common utilities and configurations on the right

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef api fill:#2196F3,stroke:#1565C0,color:white
    classDef service fill:#4CAF50,stroke:#388E3C,color:white
    classDef repo fill:#FFC107,stroke:#FFA000,color:black
    classDef security fill:#F44336,stroke:#D32F2F,color:white
    classDef config fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef model fill:#607D8B,stroke:#455A64,color:white
    classDef database fill:#795548,stroke:#5D4037,color:white
    classDef exception fill:#FF5722,stroke:#E64A19,color:white

    %% External Client
    Client(("Client"))

    %% Security & Config Layer
    subgraph Security
        SC["Security Config"]:::security
        SwaggerConfig["Swagger Config"]:::config
        JpaConfig["JPA Config"]:::config
    end
    click SC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/config/SecurityConfig.java"
    click SwaggerConfig "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/config/SwaggerConfig.java"
    click JpaConfig "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/config/JpaConfig.java"

    %% Exception Handling
    subgraph Exceptions
        GEH["Global Exception Handler"]:::exception
        AE["App Exception"]:::exception
        EC["Error Codes"]:::exception
    end
    click GEH "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/exception/GlobalExceptionHandler.java"
    click AE "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/exception/AppException.java"
    click EC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/exception/ErrorCode.java"

    %% Controller Layer
    subgraph Controllers
        BC["Base Controller"]:::api
        CC["Cart Controller"]:::api
        CatC["Category Controller"]:::api
        PC["Product Controller"]:::api
        UC["User Controller"]:::api
    end
    click BC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/controller/BaseController.java"
    click CC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/controller/CartController.java"
    click CatC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/controller/CategoryController.java"
    click PC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/controller/ProductController.java"
    click UC "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/controller/UserController.java"

    %% Service Layer
    subgraph Services
        CS["Cart Service"]:::service
        CatS["Category Service"]:::service
        PS["Product Service"]:::service
        US["User Service"]:::service
    end
    click CS "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/service/CartService.java"
    click CatS "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/service/CategoryService.java"
    click PS "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/service/ProductService.java"
    click US "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/service/UserService.java"

    %% Repository Layer
    subgraph Repositories
        CR["Cart Repository"]:::repo
        CIR["CartItem Repository"]:::repo
        CatR["Category Repository"]:::repo
        PR["Product Repository"]:::repo
        RR["Role Repository"]:::repo
        UR["User Repository"]:::repo
    end
    click CR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/CartRepository.java"
    click CIR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/CartItemRepository.java"
    click CatR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/CategoryRepository.java"
    click PR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/ProductRepository.java"
    click RR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/RoleRepository.java"
    click UR "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/repository/UserRepository.java"

    %% Domain Models
    subgraph Models
        Cart["Cart"]:::model
        CartItem["CartItem"]:::model
        Category["Category"]:::model
        Product["Product"]:::model
        Role["Role"]:::model
        User["User"]:::model
    end
    click Cart "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/Cart.java"
    click CartItem "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/CartItem.java"
    click Category "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/Category.java"
    click Product "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/Product.java"
    click Role "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/Role.java"
    click User "https://github.com/trantranloc/spring-ecommerce-api/blob/main/src/main/java/com/spring/springecommerceapi/model/User.java"

    %% Database
    DB[(Database)]:::database

    %% Relationships
    Client --> SC
    SC --> Controllers
    Controllers --> Services
    Services --> Repositories
    Repositories --> DB

    %% Specific Service Relationships
    CS --> PS
    US --> RR
    PS --> CatS

    %% Exception Flow
    Controllers -.-> GEH
    Services -.-> AE
    AE -.-> EC

    %% Model Relationships
    User --> Cart
    Cart --> CartItem
    CartItem --> Product
    Product --> Category
    User --> Role

    %% Legend
    subgraph Legend
        API[API Layer]:::api
        SVC[Service Layer]:::service
        REPO[Repository Layer]:::repo
        SEC[Security Layer]:::security
        CFG[Config Layer]:::config
        MDL[Model Layer]:::model
        EXC[Exception Layer]:::exception
        DB2[Database]:::database
    end
```
