# ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo architecture

> Architecture diagram of the GitHub repository ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo
- Repository: https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo

## Overview

##### Project Type and Purpose
- This is a minimal Spring Cloud microservices topology.
- Core purpose: demonstrate service registration/discovery (Eureka) and API routing (Spring Cloud Gateway) with two sample services.

##### File Structure
- Top-level directories:
- service-discovery – Eureka Server
- api-gateway       – Spring Cloud Gateway
- service-one       – Sample REST service A
- service-two       – Sample REST service B
- docker-compose.yml for orchestrating all four services locally.
- Each subproject is a Spring Boot/Gradle service with its own Dockerfile.

##### Extract Important Details from the README
- Spring Cloud Netflix Eureka for service registry & client.
- Spring Cloud Gateway for API routing to registered services.
- Each service registers itself with Eureka and exposes REST endpoints.

##### Main Components & Their Responsibilities
a. Client (e.g., Browser, Postman) – initiates HTTP requests
b. API Gateway – single entry point; routes incoming requests to downstream services
c. Service Discovery (Eureka Server) – holds registry of service instances
d. Service One & Service Two – two independent Spring Boot REST microservices
e. (Optional) Docker Compose – orchestrates all containers for local deployment

##### Relationships & Data Flows
1) Client → API Gateway: HTTP request (e.g. GET /service-one/…)
2) API Gateway → Eureka Server: lookup service instance(s)
3) Eureka Server → API Gateway: returns service instance location
4) API Gateway → Target Service: forwards request to Service One or Two
5) Service → Eureka Server: on startup each service registers itself
6) (Optional) Services may call each other via API Gateway + Eureka

##### Key Architectural Patterns & Design Principles
- Microservices: independently deployable units
- Service Registry: Eureka provides dynamic discovery of service instances
- API Gateway Pattern: central routing, load-balancing, filters, security
- Spring Boot / Spring Cloud: opinionated frameworks for rapid service development
- Containerization: each service runs in its own Docker container

##### Technologies / Frameworks to Annotate
- Java 21, Spring Boot
- Spring Cloud Netflix (Eureka Server & Client)
- Spring Cloud Gateway
- Gradle 8, Docker, Docker Compose

##### Final Checklist for the Engineer
- [ ] All five runtime components shown (Client, Gateway, Eureka, Service One, Service Two)
- [ ] Labels for protocols (HTTP, REST) and ports if relevant
- [ ] Boundary or note showing Docker Compose orchestration

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client
    Client["Client\n(Browser/Postman)"]:::client

    %% Docker Compose Boundary
    subgraph "Docker Compose"
        direction TB
        Gateway["API Gateway"]:::gateway
        Eureka["Service Discovery\n(Eureka Server)"]:::discovery
        S1["Service One"]:::micro
        S2["Service Two"]:::micro
    end
    DockerCompose(("docker-compose.yml")):::compose

    %% Connections
    Client -->|"HTTP request"| Gateway
    Gateway -->|"Lookup service"| Eureka
    Eureka -->|"Return instances"| Gateway
    Gateway -->|"Route request"| S1
    Gateway -->|"Route request"| S2
    S1 -->|"Register on startup"| Eureka
    S2 -->|"Register on startup"| Eureka
    DockerCompose -.-> Gateway
    DockerCompose -.-> Eureka
    DockerCompose -.-> S1
    DockerCompose -.-> S2

    %% Click Events for API Gateway
    click Gateway "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/api-gateway/src/main/java/net/ddns/ilinpetar/apigateway/ApiGatewayApplication.java"
    click GatewayConfig "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/api-gateway/src/main/resources/application.properties"
    click GatewayEureka "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/api-gateway/src/main/resources/eureka-client.properties"
    click GatewayRoutes "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/api-gateway/src/main/resources/static-routes.properties"
    click DockerfileGateway "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/tree/master/api-gateway/Dockerfile"

    %% Click Events for Service Discovery
    click Eureka "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-discovery/src/main/java/net/ddns/ilinpetar/servicediscovery/ServiceDiscoveryApplication.java"
    click SDConfig "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-discovery/src/main/resources/application.properties"
    click SDEureka "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-discovery/src/main/resources/eureka-client.properties"
    click DockerfileSD "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/tree/master/service-discovery/Dockerfile"

    %% Click Events for Service One
    click S1 "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-one/src/main/java/net/ddns/ilinpetar/servicea/ServiceOneApplication.java"
    click S1Controller "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-one/src/main/java/net/ddns/ilinpetar/servicea/ServiceOneController.java"
    click S1Config "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-one/src/main/resources/application.properties"
    click DockerfileS1 "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/tree/master/service-one/Dockerfile"

    %% Click Events for Service Two
    click S2 "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-two/src/main/java/net/ddns/ilinpetar/servicea/ServiceTwoApplication.java"
    click S2Controller "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-two/src/main/java/net/ddns/ilinpetar/servicea/ServiceTwoController.java"
    click S2Config "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/service-two/src/main/resources/application.properties"
    click DockerfileS2 "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/tree/master/service-two/Dockerfile"

    %% Click Event for Docker Compose
    click DockerCompose "https://github.com/ilinpetar/spring-cloud-service-discovery-and-api-gateway-demo/blob/master/docker-compose.yml"

    %% Styles
    classDef client fill:#cccccc,stroke:#333,stroke-width:1px
    classDef gateway fill:#bbdefb,stroke:#1e88e5,stroke-width:2px
    classDef discovery fill:#c8e6c9,stroke:#43a047,stroke-width:2px,shape:cylinder
    classDef micro fill:#ffe0b2,stroke:#fb8c00,stroke-width:2px
    classDef compose fill:none,stroke:#9e9e9e,stroke-dasharray: 5 5,stroke-width:2px,shape:rect
```
