# youceyf11/reporting-microservices-app architecture

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

- Interactive diagram: https://gitdiagram.com/youceyf11/reporting-microservices-app
- Repository: https://github.com/youceyf11/reporting-microservices-app

## Overview

##### Project type and purpose
- This is a Java-based, Spring Boot microservices application (“Reporting-Microservices-App”) composed of two independently deployable services:
- jira-fetch-service: periodically fetches issues from the Jira REST API, transforms and persists them to a reactive database.
- reporting-service: reads persisted Jira data and exposes reporting endpoints (or generates reports).
- There’s a standalone Main.java at the root, but the two primary components are the Spring Boot services under their own Maven modules.

##### File structure
- Top-level modules:
- jira-fetch-service (Spring Boot, WebClient for Jira, R2DBC database)
- reporting-service (Spring Boot, likely REST layer or scheduled jobs for reporting)
- Each service follows a standard MVC pattern:
- config/ – application configuration (DB, WebClient, repositories)
- controller/ – REST controllers
- service/ – business logic
- repository/ – reactive repositories for persistence
- dto/, entity/, mapper/ – data model and mappers
- client/ – JiraWebClient in jira-fetch-service
- Build and deployment files: pom.xml in each module; Maven wrapper.

##### README for additional insights
- The README only contains the project title, no extra architecture notes. We rely on the module names, package structures, and standard Spring Boot conventions.

a. Main components:
1. External Jira REST API
2. jira-fetch-service (WebClient, Service layer, Reactive DB access)
3. Reactive Database (e.g., PostgreSQL with R2DBC)
4. reporting-service (REST controller or report generator)
5. (Optional) Clients or UIs consuming reporting-service APIs
b. Relationships and data flow:
- jira-fetch-service triggers a scheduled or on-demand fetch → calls Jira REST API → receives JSON payload → maps to dto/entity → writes to reactive DB.
- reporting-service reads from reactive DB → transforms data → exposes over its REST endpoints or produces report files.
- Upstream clients (web/mobile/CLI) call reporting-service’s REST API.
c. Architectural patterns & design principles:
- Microservices: independently deployable, own database schema.
- Reactive programming (WebClient + R2DBC) for non-blocking I/O.
- Layered architecture (Controller → Service → Repository).
- Configuration via Spring Boot auto-config and explicit @Configuration classes.
d. Key technologies, frameworks, libraries:
- Spring Boot
- Spring WebFlux (JiraWebClient)
- Spring Data R2DBC
- Maven (multi-module)
- Lombok (to be added for DTO/Entity boilerplate)
- (Possibly Spring Scheduler if fetch is periodic)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External system
    JiraAPI["External Jira REST API"]:::external

    %% Jira Fetch Service Module
    subgraph "jira-fetch-service"
        direction TB
        JFSModule["jira-fetch-service (module root)"]:::module
        JFSApp["JiraFetchServiceApplication"]:::entry
        WebClientConfig["WebClientConfig"]:::config
        R2dbcConfig["R2dbcConfig"]:::config
        DBInit["DatabaseInitializer"]:::config
        JiraWebClient["JiraWebClient"]:::client
        JiraIssueController["JiraIssueController"]:::controller
        JiraIssueService["JiraIssueService"]:::service
        JiraIssueRepository["JiraIssueRepository"]:::repository
        JiraMapper["JiraMapper"]:::mapper
        GlobalExceptionHandler["GlobalExceptionHandler"]:::exception
        subgraph "DTOs & Entities"
            JiraIssueApiDto["JiraIssueApiDto"]:::dto
            JiraIssueDto["JiraIssueDto"]:::dto
            JiraIssueDbEntity["JiraIssueDbEntity"]:::entity
            UserEntity["User"]:::entity
        end
        JFSModule --> JFSApp
        JFSApp --> WebClientConfig
        JFSApp --> R2dbcConfig
        WebClientConfig --> JiraWebClient
        JiraWebClient --> JiraIssueService
        JiraIssueController --> JiraIssueService
        JiraIssueService --> JiraIssueRepository
        JiraIssueService --> JiraMapper
        JiraIssueRepository --> DBInit
        JiraMapper --> JiraIssueApiDto
        JiraMapper --> JiraIssueDto
        JiraMapper --> JiraIssueDbEntity
        DBInit --> JiraIssueDbEntity
        JiraIssueController --> GlobalExceptionHandler
    end

    %% Database
    Database[(Reactive Database)]:::db

    %% Reporting Service Module
    subgraph "reporting-service"
        direction TB
        RSModule["reporting-service (module root)"]:::module
        RSApp["ReportingServiceApplication"]:::entry
        ReportController["ReportController"]:::controller
        ReportService["ReportService"]:::service
        ReportRepository["ReportRepository"]:::repository
        RSModule --> RSApp
        RSApp --> ReportController
        ReportController --> ReportService
        ReportService --> ReportRepository
    end

    %% Clients
    Clients["Clients (Web/Mobile/CLI)"]:::external

    %% Data flows
    JiraWebClient -->|HTTP GET/POST| JiraAPI
    JiraAPI -->|JSON payload| JiraWebClient
    JiraIssueRepository -->|R2DBC write| Database
    ReportRepository -->|R2DBC read| Database
    Clients -->|HTTP REST calls| ReportController

    %% Click events
    click JFSModule "https://github.com/youceyf11/reporting-microservices-app/tree/main/jira-fetch-service/"
    click JFSApp "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/JiraFetchServiceApplication.java"
    click JiraWebClient "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/client/JiraWebClient.java"
    click R2dbcConfig "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/config/R2dbcConfig.java"
    click DBInit "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/config/DatabaseInitializer.java"
    click WebClientConfig "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/config/WebClientConfig.java"
    click JiraIssueController "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/controller/JiraIssueController.java"
    click JiraIssueService "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/service/JiraIssueService.java"
    click JiraIssueRepository "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/repository/JiraIssueRepository.java"
    click JiraIssueApiDto "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/dto/JiraIssueApiDto.java"
    click JiraIssueDto "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/dto/JiraIssueDto.java"
    click JiraIssueDbEntity "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/entity/JiraIssueDbEntity.java"
    click UserEntity "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/entity/User.java"
    click JiraMapper "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/mapper/JiraMapper.java"
    click GlobalExceptionHandler "https://github.com/youceyf11/reporting-microservices-app/blob/main/jira-fetch-service/src/main/java/org/project/jirafetchservice/exception/GlobalExceptionHandler.java"
    click RSModule "https://github.com/youceyf11/reporting-microservices-app/tree/main/reporting-service/"
    click RSApp "https://github.com/youceyf11/reporting-microservices-app/blob/main/reporting-service/src/main/java/org/project/reportingservice/ReportingServiceApplication.java"
    click MainFile "https://github.com/youceyf11/reporting-microservices-app/blob/main/src/main/java/org/project/Main.java"

    %% Styles
    classDef module fill:#f2f2f2,stroke:#aaa,stroke-width:1px;
    classDef entry fill:#fff2cc,stroke:#e6b800,stroke-width:1px;
    classDef config fill:#e6ffe6,stroke:#33cc33,stroke-width:1px;
    classDef client fill:#e6f7ff,stroke:#3399ff,stroke-width:1px;
    classDef controller fill:#e6e6ff,stroke:#6666ff,stroke-width:1px;
    classDef service fill:#fff0e6,stroke:#ff9933,stroke-width:1px;
    classDef repository fill:#f9e6ff,stroke:#cc33ff,stroke-width:1px;
    classDef mapper fill:#ffe6f2,stroke:#ff33aa,stroke-width:1px;
    classDef exception fill:#ffe6e6,stroke:#ff3333,stroke-width:1px;
    classDef dto fill:#f2f2f2,stroke:#999,stroke-dasharray: 2 2;
    classDef entity fill:#f2f2f2,stroke:#999,stroke-dasharray: 2 2;
    classDef db fill:#ccccff,stroke:#6666cc,stroke-width:1px;
    classDef external fill:#ffe6b3,stroke:#cc9900,stroke-width:1px;
```
