How youceyf11/reporting-microservices-app works
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)