# zoltanvin/royal-reserve-bank architecture

> Architecture diagram of the GitHub repository zoltanvin/royal-reserve-bank, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zoltanvin/royal-reserve-bank
- Repository: https://github.com/zoltanvin/royal-reserve-bank

## Overview

##### Project Type and Purpose
- This is a Spring Boot – Spring Cloud microservices banking solution.
- Goal: support account management, transactions, asset queries, notifications – all coordinated via an API Gateway, with centralized config, service discovery, monitoring, tracing, caching, event-driven messaging, and containerization.

##### File Structure
- Top-level modules:
– api-gateway
– account-api
– transaction-api
– asset-management-api
– notification-api
– config-server
– discovery-server
- Infrastructure files:
– docker-compose.yml / docker-compose-infrastructure-services.yml
– config-files for each service
– postman/ for manual testing
– docs/javadoc for API reference
- Each microservice follows a Spring Boot Maven layout (src/main/java, src/main/resources, src/test).

##### Extract Key Architecture from README
- High-level architecture: microservices + API Gateway + Config Server + Discovery Server + databases + Kafka + Redis + Zipkin + Prometheus + Grafana.
- Patterns in use: Service Discovery (Eureka), Centralized Config (Config Server), Distributed Tracing (Zipkin), Event-Driven (Kafka), DB per Service, Cache-Aside (Redis/Spring Cache), Circuit Breaker (Resilience4J), Security (Auth0 via Gateway), Containerization (Docker).

a. Components
1. Clients
– Web/Mobile/App or Postman (external actors)
2. API Gateway
– Entry point, handles Auth0 authentication/authorization
3. Service Discovery (Eureka Discovery Server)
4. Centralized Configuration (Spring Cloud Config Server)
5. Microservices (all Spring Boot apps)
– Account API (MongoDB + Redis cache)
– Transaction API (PostgreSQL + Spring Cache + Resilience4J circuit breaker)
– Asset Management API (MySQL + Spring Cache)
– Notification API (stateless, consumes Kafka events)
6. External Systems
– MongoDB, PostgreSQL, MySQL
– Redis
– Apache Kafka cluster
– Zipkin tracing server
– Prometheus & Grafana for metrics & dashboards
7. Infrastructure
– Docker / Docker Compose orchestration

b. Relationships & Data Flows
1. Client → API Gateway (HTTPS, JWT via Auth0)
2. API Gateway ↔ Eureka for service lookup
3. API Gateway → Individual Microservices (load-balanced via Eureka)
4. Microservices at startup → Config Server (HTTP) to fetch their config
5. Account API reads/writes → MongoDB; caches reads in Redis
6. Transaction API:
– On transaction request: synchronously calls Account API & Asset API (via WebClient)
– Records transaction → PostgreSQL; caches data (Spring Cache); protects calls with Resilience4J
7. Asset Management API reads/writes → MySQL; caches data
8. Notification API: subscribes to Kafka topic “transaction-events”; processes messages → sends email/SMS
9. All services send trace spans → Zipkin
10. Prometheus scrapes metrics from all services → Grafana dashboards

c. Architectural Patterns Highlighted
- Service Discovery – dynamic service resolution via Eureka
- Centralized Config – externalized, environment-specific properties via Config Server
- Event-Driven – decoupled notifications via Kafka pub/sub
- Database per Microservice – independent schemas & scaling
- Cache-Aside – Redis (Account API) + Spring Cache (Transaction/Asset APIs)
- Circuit Breaker – Resilience4J wrapping inter-service calls in Transaction API
- Distributed Tracing – Zipkin instrumentation of each service
- Security – JWT tokens at API Gateway (Auth0)
- Containerization – Docker images & Compose orchestration

d. Technologies & Frameworks
- Java 17, Spring Boot, Spring Cloud (Config, Netflix Eureka)
- Spring Data (MongoDB, JPA for PostgreSQL/MySQL)
- Redis, Kafka, Zipkin, Prometheus, Grafana
- Resilience4J, Spring Cache, Auth0
- Docker, Docker Compose

##### Final Advice
– Start by sketching the high-level view: client, gateway, core services, infra.
– Drill down on each microservice’s dependencies: DB, cache, event bus, other APIs.
– Emphasize architectural patterns by grouping components (e.g., Eureka + Config grouped under “Spring Cloud Core”).
– Iterate with stakeholders to ensure accuracy and completeness.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    subgraph "Clients"
        Client["Postman"]:::external
    end

    %% Spring Cloud Core
    subgraph "Spring Cloud Core"
        ConfigServer["Config Server"]:::core
        DiscoveryServer["Eureka Discovery Server"]:::core
    end

    %% API Layer
    subgraph "API Layer"
        APIGateway["API Gateway"]:::gateway
    end

    %% Microservices
    subgraph "Microservices"
        AccountAPI["Account API"]:::service
        TransactionAPI["Transaction API"]:::service
        AssetAPI["Asset Management API"]:::service
        NotificationAPI["Notification API"]:::service
    end

    %% Databases & Cache
    subgraph "Databases & Cache"
        MongoDB["MongoDB"]:::db
        Postgres["PostgreSQL"]:::db
        MySQL["MySQL"]:::db
        Redis["Redis Cache"]:::cache
    end

    %% Messaging & Monitoring
    Kafka["Kafka"]:::messaging
    Zipkin["Zipkin"]:::monitor
    Prometheus["Prometheus"]:::monitor
    Grafana["Grafana"]:::monitor

    %% Infrastructure
    subgraph "Infrastructure"
        DockerCompose["Docker Compose"]:::infra
    end

    %% Connections
    Client -->|HTTPS JWT| APIGateway
    APIGateway -->|register/discover| DiscoveryServer
    APIGateway -->|REST call| AccountAPI
    APIGateway -->|REST call| TransactionAPI
    APIGateway -->|REST call| AssetAPI
    APIGateway -->|REST call| NotificationAPI

    AccountAPI -->|fetch config| ConfigServer
    TransactionAPI -->|fetch config| ConfigServer
    AssetAPI -->|fetch config| ConfigServer
    NotificationAPI -->|fetch config| ConfigServer

    AccountAPI -->|register| DiscoveryServer
    TransactionAPI -->|register| DiscoveryServer
    AssetAPI -->|register| DiscoveryServer
    NotificationAPI -->|register| DiscoveryServer

    AccountAPI -->|read/write| MongoDB
    AccountAPI -->|cache read/write| Redis

    TransactionAPI -->|read/write| Postgres
    TransactionAPI -->|cache read/write| Redis
    TransactionAPI -->|sync call| AccountAPI
    TransactionAPI -->|sync call| AssetAPI

    AssetAPI -->|read/write| MySQL

    TransactionAPI -->|publish| Kafka
    NotificationAPI -.->|consume| Kafka

    AccountAPI -->|trace span| Zipkin
    TransactionAPI -->|trace span| Zipkin
    AssetAPI -->|trace span| Zipkin
    NotificationAPI -->|trace span| Zipkin

    Prometheus -->|scrape metrics| AccountAPI
    Prometheus -->|scrape metrics| TransactionAPI
    Prometheus -->|scrape metrics| AssetAPI
    Prometheus -->|scrape metrics| NotificationAPI
    Prometheus -->|dashboards| Grafana
    Grafana -->|visualize| Prometheus

    DockerCompose -->|orchestrates| ConfigServer
    DockerCompose -->|orchestrates| DiscoveryServer
    DockerCompose -->|orchestrates| APIGateway
    DockerCompose -->|orchestrates| AccountAPI
    DockerCompose -->|orchestrates| TransactionAPI
    DockerCompose -->|orchestrates| AssetAPI
    DockerCompose -->|orchestrates| NotificationAPI
    DockerCompose -->|orchestrates| MongoDB
    DockerCompose -->|orchestrates| Postgres
    DockerCompose -->|orchestrates| MySQL
    DockerCompose -->|orchestrates| Redis
    DockerCompose -->|orchestrates| Kafka
    DockerCompose -->|orchestrates| Zipkin
    DockerCompose -->|orchestrates| Prometheus
    DockerCompose -->|orchestrates| Grafana

    %% Click Events
    click Client "https://github.com/zoltanvin/royal-reserve-bank/blob/main/postman/postman-collection.json"
    click APIGateway "https://github.com/zoltanvin/royal-reserve-bank/blob/main/api-gateway/src/main/java/com/royal/reserve/bank/api/gateway/ApiGatewayApplication.java"
    click APIGateway "https://github.com/zoltanvin/royal-reserve-bank/blob/main/api-gateway/src/main/java/com/royal/reserve/bank/api/gateway/config/SecurityConfig.java"
    click DiscoveryServer "https://github.com/zoltanvin/royal-reserve-bank/blob/main/discovery-server/src/main/java/com/royal/reserve/bank/discovery/server/DiscoveryServerApplication.java"
    click DiscoveryServer "https://github.com/zoltanvin/royal-reserve-bank/blob/main/discovery-server/src/main/java/com/royal/reserve/bank/discovery/server/config/SecurityConfig.java"
    click ConfigServer "https://github.com/zoltanvin/royal-reserve-bank/blob/main/config-server/src/main/java/com/royal/reserve/bank/config/server/ConfigServerApplication.java"
    click AccountAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/account-api/src/main/java/com/royal/reserve/bank/account/api/AccountApiApplication.java"
    click AccountAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/account-api/src/main/java/com/royal/reserve/bank/account/api/config/RedisConfig.java"
    click AccountAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/account-api/src/main/java/com/royal/reserve/bank/account/api/controller/AccountController.java"
    click TransactionAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/transaction-api/src/main/java/com/royal/reserve/bank/transaction/api/TransactionApiApplication.java"
    click TransactionAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/transaction-api/src/main/java/com/royal/reserve/bank/transaction/api/config/WebClientConfig.java"
    click TransactionAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/transaction-api/src/main/java/com/royal/reserve/bank/transaction/api/client/AssetManagementClient.java"
    click TransactionAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/transaction-api/src/main/java/com/royal/reserve/bank/transaction/api/controller/TransactionController.java"
    click AssetAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/asset-management-api/src/main/java/com/royal/reserve/bank/asset/management/api/AssetManagementApiApplication.java"
    click AssetAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/asset-management-api/src/main/java/com/royal/reserve/bank/asset/management/api/controller/AssetManagementController.java"
    click NotificationAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/notification-api/src/main/java/com/royal/reserve/bank/notification/api/NotificationApiApplication.java"
    click NotificationAPI "https://github.com/zoltanvin/royal-reserve-bank/blob/main/notification-api/src/main/java/com/royal/reserve/bank/notification/api/event/TransactionEvent.java"
    click DockerCompose "https://github.com/zoltanvin/royal-reserve-bank/blob/main/docker-compose.yml"
    click DockerCompose "https://github.com/zoltanvin/royal-reserve-bank/blob/main/docker-compose-infrastructure-services.yml"
    click ConfigServer "https://github.com/zoltanvin/royal-reserve-bank/blob/main/config-files/api-gateway.properties"

    %% Styles
    classDef external fill:#E8F1FF,stroke:#1E70BF,color:#1E70BF;
    classDef gateway fill:#004D40,stroke:#004D40,color:#FFFFFF;
    classDef core fill:#FFF3E0,stroke:#FB8C00,color:#BF360C;
    classDef service fill:#E8F5E9,stroke:#43A047,color:#1B5E20;
    classDef db fill:#E3F2FD,stroke:#1976D2,color:#0D47A1,shape:cylinder;
    classDef cache fill:#FFFDE7,stroke:#FBC02D,color:#F57F17,shape:cylinder;
    classDef messaging fill:#F3E5F5,stroke:#8E24AA,color:#4A148C;
    classDef monitor fill:#EFEBE9,stroke:#6D4C41,color:#3E2723;
    classDef infra fill:#ECEFF1,stroke:#546E7A,color:#263238;
```
