# nettee-space/backend-sample-layered-simple-crud architecture

> Architecture diagram of the GitHub repository nettee-space/backend-sample-layered-simple-crud, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nettee-space/backend-sample-layered-simple-crud
- Repository: https://github.com/nettee-space/backend-sample-layered-simple-crud

## Overview

##### Project Type Analysis
This is a Spring Boot application implementing a layered architecture with CRUD operations, using Spring Data JPA for persistence. The project follows clean architecture principles with clear separation of concerns.

##### Key Components

A. Main Layers (Top to Bottom):
- API Layer (Controllers)
- Service Layer
- Repository Layer
- Database Layer

B. Cross-cutting Components:
- Common/Shared Components
- Exception Handling
- Database Migration

**┌─────────────────────────────────────────────────────────┐**
- API Layer                           │
- ┌─────────────────┐            ┌────────────────────┐  │
- BoardCommandApi│            │   BoardQueryApi    │  │
- ┘            └────────────────────┘  │
- ┤
- Service Layer                        │
- ┌─────────────────┐            ┌────────────────────┐  │
- BoardCommandService           │BoardQueryService   │  │
- ┘            └────────────────────┘  │
- ┤
- Repository Layer                      │
- ┌─────────────────┐            ┌────────────────────┐  │
- BoardCommandRepo │            │  BoardQueryRepo    │  │
- ┘            └────────────────────┘  │
- ┤
- Database Layer                        │
- ┌─────────────────────────────────────────────────┐    │
- PostgreSQL Database                │    │
- ┘    │
- ┘

##### Additional Components

Cross-cutting Concerns (Show as vertical components on the right):
**┌─────────────────┐**
- Exception       │
- Handling        │
- ┤
- Common          │
- Components      │
- ┤
- Database        │
- Migration       │
- ┘

##### Important Details to Highlight

- Command-Query Separation (CQS) pattern implementation
- Use Case implementations for specific operations
- JPA entity relationships
- Flyway migration scripts
- DTOs and mapping structure

##### Implementation Notes

- Separation between command and query operations
- Use of Spring Data JPA
- Docker container for PostgreSQL
- Relationship with Flyway migrations

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef api fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef repository fill:#e67e22,stroke:#d35400,color:white
    classDef database fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef domain fill:#9b59b6,stroke:#8e44ad,color:white
    classDef usecase fill:#1abc9c,stroke:#16a085,color:white
    classDef dto fill:#f1c40f,stroke:#f39c12,color:white
    classDef common fill:#34495e,stroke:#2c3e50,color:white

    %% API Layer
    subgraph API
        CommandApi["Board Command API"]:::api
        QueryApi["Board Query API"]:::api
        CommandDto["Command DTOs"]:::dto
        QueryDto["Query DTOs"]:::dto
        DtoMapper["DTO Mapper"]:::dto
    end

    %% Service Layer
    subgraph Service
        CommandService["Board Command Service"]:::service
        QueryService["Board Query Service"]:::service
    end

    %% Use Cases
    subgraph UseCases
        CreateUC["Create Use Case"]:::usecase
        DeleteUC["Delete Use Case"]:::usecase
        SelectAllUC["Select All Use Case"]:::usecase
        SelectOneUC["Select One Use Case"]:::usecase
        UpdateUC["Update Use Case"]:::usecase
    end

    %% Repository Layer
    subgraph Repository
        CommandRepo["Board Command Repository"]:::repository
        QueryRepo["Board Query Repository"]:::repository
    end

    %% Domain Layer
    subgraph Domain
        BoardEntity["Board Entity"]:::domain
        BoardStatus["Board Status"]:::domain
    end

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

    %% Cross-cutting Concerns
    subgraph CrossCutting
        ExceptionHandler["Global Exception Handler"]:::common
        BaseEntity["Base Entity"]:::common
        DBMigration["Database Migration"]:::common
        CommandEx["Command Exceptions"]:::common
        QueryEx["Query Exceptions"]:::common
    end

    %% Relationships
    CommandApi --> CommandDto
    QueryApi --> QueryDto
    CommandDto --> DtoMapper
    QueryDto --> DtoMapper
    DtoMapper --> BoardEntity

    CommandApi --> CommandService
    QueryApi --> QueryService

    CommandService --> CreateUC & UpdateUC & DeleteUC
    QueryService --> SelectAllUC & SelectOneUC

    CreateUC & UpdateUC & DeleteUC --> CommandRepo
    SelectAllUC & SelectOneUC --> QueryRepo

    CommandRepo --> BoardEntity
    QueryRepo --> BoardEntity

    BoardEntity --> BoardStatus
    BoardEntity --> BaseEntity

    CommandRepo --> DB
    QueryRepo --> DB

    CommandEx -.-> ExceptionHandler
    QueryEx -.-> ExceptionHandler
    DBMigration -.-> DB

    %% Click Events
    click CommandApi "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/controller/BoardCommandApi.java"
    click QueryApi "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/controller/BoardQueryApi.java"
    click CommandService "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/service/BoardCommandService.java"
    click QueryService "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/service/BoardQueryService.java"
    click CommandRepo "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/repository/BoardCommandRepository.java"
    click QueryRepo "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/repository/BoardQueryRepository.java"
    click BoardEntity "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/domain/Board.java"
    click BoardStatus "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/domain/type/BoardStatus.java"
    click CreateUC "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/usecase/BoardCreateUseCase.java"
    click DeleteUC "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/usecase/BoardDeleteUseCase.java"
    click SelectAllUC "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/usecase/BoardSelectAllUseCase.java"
    click SelectOneUC "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/usecase/BoardSelectOneUseCase.java"
    click UpdateUC "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/usecase/BoardUpdateUseCase.java"
    click CommandDto "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/controller/dto/BoardCommandDto.java"
    click QueryDto "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/controller/dto/BoardQueryDto.java"
    click ExceptionHandler "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/common/exeption/GlobalExceptionHandler.java"
    click BaseEntity "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/common/jpa/support/BaseEntity.java"
    click DBMigration "https://github.com/nettee-space/backend-sample-layered-simple-crud/tree/main/src/main/resources/db/migration/v1_0"
    click CommandEx "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/exception/BoardCommandException.java"
    click QueryEx "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/exception/BoardQueryException.java"
    click DtoMapper "https://github.com/nettee-space/backend-sample-layered-simple-crud/blob/main/src/main/java/me/nettee/board/mapper/BoardDtoMapper.java"
```
