# mkalaimalai/user-microservices-jpa architecture

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

- Interactive diagram: https://gitdiagram.com/mkalaimalai/user-microservices-jpa
- Repository: https://github.com/mkalaimalai/user-microservices-jpa

## Overview

##### Project type and purpose
- This is a single‐purpose “User” microservice built with Spring Boot and JPA.
- It exposes REST endpoints for CRUD operations on users (see UserRestController), persists data to a database via Spring Data JPA (UserRepository), and uses Ehcache for caching.

##### File structure
- Top-level build & infra:
- pom.xml, mvnw(.cmd) – Maven wrapper & build definition
- Dockerfile – containerization
- application-*.yml – environment-specific configs (dev, aws, default)
- ehcache.xml, logback-spring.xml – caching & logging
- Source code layout (classic layered pattern):
- controller/ – REST endpoints
- service/ – business logic
- repository/ – Spring Data JPA interfaces
- domain/ – JPA entities & enums
- mapper/ – DTO ↔ entity mapping
- vo/ – request/response objects (VOs)
- exception/ – centralized error handling
- Tests mirror the same structure under src/test.

##### README for additional insights
- “User Micro Services” indicates it’s one microservice in a potentially larger ecosystem.
- Builds & runs via Maven; exposes Swagger UI on port 8080.
- Provides sample curl for POST /api/user.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Client["Swagger UI / Postman"]:::external
    click Client "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/README.md"

    subgraph "Docker Container"
        subgraph "Spring Boot Application"
            %% API Layer
            subgraph "API Layer"
                URC["UserRestController"]:::controller
                click URC "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/controller/UserRestController.java"
            end

            %% Service Layer
            subgraph "Service Layer"
                US["UserService"]:::service
                click US "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/service/UserService.java"
            end

            %% Mapper Layer
            subgraph "Mapper Layer"
                UM["UserMapper"]:::mapper
                click UM "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/mapper/UserMapper.java"
            end

            %% Data Access Layer
            subgraph "Data Access Layer"
                UR["UserRepository"]:::data
                click UR "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/repository/UserRepository.java"

                subgraph "Domain Model"
                    UEnt["User Entity"]:::domain
                    click UEnt "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/domain/User.java"
                    AEnt["Address Entity"]:::domain
                    click AEnt "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/domain/Address.java"
                    AT["AddressType Enum"]:::domain
                    click AT "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/domain/AddressType.java"
                end
            end

            %% VO Layer
            subgraph "Value Objects (VOs)"
                UVO["UserVO"]:::vo
                click UVO "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/vo/UserVO.java"
                AVO["AddressVO"]:::vo
                click AVO "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/vo/AddressVO.java"
                BVO["BaseVO"]:::vo
                click BVO "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/vo/BaseVO.java"
            end

            %% Exception Handling
            subgraph "Exception Handling"
                GEH["GlobalExceptionHandler"]:::exception
                click GEH "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/exception/GlobalExceptionHandler.java"
                RNF["ResourceNotFoundException"]:::exception
                click RNF "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/exception/ResourceNotFoundException.java"
                ER["Error, ErrorVO, FieldErrorVO"]:::exception
                click ER "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/java/com/mkalaimalai/exception/Error.java"
            end

            %% Infrastructure Components
            Cache["Ehcache"]:::infra
            click Cache "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/resources/ehcache.xml"
            DB["Database (RDS/PostgreSQL)"]:::infra
            Config["Application Configs"]:::infra
            click Config "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/resources/application.yml"
            click Config "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/resources/application-dev.yml"
            click Config "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/resources/application-aws.yml"
            Log["Logback Config"]:::infra
            click Log "https://github.com/mkalaimalai/user-microservices-jpa/blob/master/src/main/resources/logback-spring.xml"
            DF["Dockerfile"]:::infra
            click DF "https://github.com/mkalaimalai/user-microservices-jpa/tree/master/Dockerfile"
        end
    end

    %% Interactions
    Client -->|"HTTP Request (GET/POST)"| URC
    URC -->|"calls"| US
    US -->|"uses"| UM
    UM -->|"maps"| US
    US -->|"CRUD operations"| UR
    UR -->|"SQL Queries"| DB
    US -->|"checks/populates"| Cache
    UR -->|"cache interceptor"| Cache
    URC -->|"handles errors via"| GEH
    Config -->|"load properties"| URC

    %% Styles
    classDef external fill:#F2F3F4,stroke:#333,stroke-width:1px
    classDef controller fill:#D0E6F5,stroke:#333,stroke-width:1px
    classDef service fill:#D5F5D0,stroke:#333,stroke-width:1px
    classDef mapper fill:#F9E79F,stroke:#333,stroke-width:1px
    classDef data fill:#F5D0A9,stroke:#333,stroke-width:1px
    classDef domain fill:#FADBD8,stroke:#333,stroke-width:1px
    classDef vo fill:#FCF3CF,stroke:#333,stroke-width:1px
    classDef exception fill:#E8DAEF,stroke:#333,stroke-width:1px
    classDef infra fill:#E0E0E0,stroke:#333,stroke-width:1px
```
