# java-techie-jt/feign-client-demo architecture

> Architecture diagram of the GitHub repository java-techie-jt/feign-client-demo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/java-techie-jt/feign-client-demo
- Repository: https://github.com/java-techie-jt/feign-client-demo

## Overview

Step 1: Identify the project type and purpose
- This is a simple two-microservice demo built with Spring Boot and Spring Cloud OpenFeign (“feign-client-demo”).
- course-service exposes a REST API to retrieve course data from an in-memory JSON file.
- student-service exposes a REST API to retrieve student information and enrich it by calling course-service via a Feign client.

Step 2: Analyze the file structure
- Top-level: two Maven modules, course-service and student-service.
- Each module follows standard Spring Boot layout:
- src/main/java/com/javatechie/{…}
- controller, service, dto (data transfer objects), client (in student-service)
- src/main/resources holds application configuration and, for course-service, courses.json
- No gateway or discovery server—services communicate directly via Feign.

Step 3: Examine the README for additional insights
- The README only names the project. But file names (CourseClient, CourseRestClientService) confirm use of Feign for inter-service calls.

a. Main components
1. Client (Postman, Web UI, etc.)
2. student-service
– StudentController
– StudentService
– Feign Client (CourseClient/CourseRestClientService)
3. course-service
– CourseController
– CourseService
– courses.json data store
4. External dependencies: HTTP over TCP/IP

b. Relationships and interactions
- Client → StudentController (HTTP GET /students/{id})
- StudentController → StudentService → CourseClient (Feign) → CourseController on course-service
- CourseController → CourseService → courses.json

c. Architectural patterns/design principles
- Microservices (two independent deployable services)
- Layered architecture inside each service: Controller → Service → Data (file store)
- Declarative REST client (Spring Cloud OpenFeign) for inter-service communication
- Externalized configuration (application.properties / yml)

d. Relevant technologies/frameworks
- Spring Boot
- Spring Web (REST controllers)
- Spring Cloud OpenFeign
- Maven (pom.xml)
- In-memory JSON data source for demo

- For this microservice demo:
- Ports (e.g., 8080 for student-service, 8081 for course-service) if known.
- Feign client in student-service pointing to course-service’s REST endpoint.

- Clear labels for each service and inner component (“CourseController”, “StudentService”, etc.).
- Blue rectangles for services
- Green for controllers
- Yellow for service/business logic

Step 7: Be detailed—capture all essential elements
- Exactly which DTO classes flow across the boundary (Course, Rating).
- Configuration files driving ports or endpoints (application.properties/yml).

[Client]
|
v
[Student-Service]
├─ StudentController
├─ StudentService
└─ FeignClient → (HTTP GET) → [Course-Service]
├─ CourseController
├─ CourseService
└─ courses.json datastore

## Diagram (Mermaid)

```mermaid
graph TD
    Client["Client (Postman/UI)"]:::external

    subgraph "Student-Service (8080)"
        SSA["StudentServiceApplication"]:::service
        SController["StudentController"]:::controller
        SService["StudentService"]:::biz
        CClient["CourseClient (Feign Interface)"]:::client
        CRClient["CourseRestClientService"]:::client
        S_CourseDTO["Course DTO"]:::dto
        S_RatingDTO["Rating DTO"]:::dto
        S_Prop["application.properties"]:::config
        S_Yaml["application.yml"]:::config
    end

    subgraph "Course-Service (8081)"
        CSA["CourseServiceApplication"]:::service
        CController["CourseController"]:::controller
        CService["CourseService"]:::biz
        C_CourseDTO["Course DTO"]:::dto
        C_RatingDTO["Rating DTO"]:::dto
        JSON["courses.json"]:::datastore
        C_Prop["application.properties"]:::config
    end

    Client -->|"GET /students/{id}"| SController
    SController -->|"invokes"| SService
    SService -->|"uses Feign"| CClient
    CClient -->|"proxy call"| CRClient
    CRClient -->|"GET /courses/{id}"| CController
    CController -->|"delegates"| CService
    CService -->|"reads data"| JSON

    click SSA "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/StudentServiceApplication.java"
    click SController "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/controller/StudentController.java"
    click SService "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/service/StudentService.java"
    click CClient "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/client/CourseClient.java"
    click CRClient "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/client/CourseRestClientService.java"
    click S_CourseDTO "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/dto/Course.java"
    click S_RatingDTO "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/java/com/javatechie/dto/Rating.java"
    click S_Prop "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/resources/application.properties"
    click S_Yaml "https://github.com/java-techie-jt/feign-client-demo/blob/main/student-service/src/main/resources/application.yml"

    click CSA "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/java/com/javatechie/CourseServiceApplication.java"
    click CController "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/java/com/javatechie/controller/CourseController.java"
    click CService "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/java/com/javatechie/service/CourseService.java"
    click C_CourseDTO "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/java/com/javatechie/dto/Course.java"
    click C_RatingDTO "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/java/com/javatechie/dto/Rating.java"
    click JSON "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/resources/courses.json"
    click C_Prop "https://github.com/java-techie-jt/feign-client-demo/blob/main/course-service/src/main/resources/application.properties"

    classDef external fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef service fill:#d0e6fa,stroke:#333,stroke-width:1px
    classDef controller fill:#b7e4c7,stroke:#333,stroke-width:1px
    classDef biz fill:#fff3b0,stroke:#333,stroke-width:1px
    classDef client fill:#a0c4ff,stroke:#333,stroke-width:1px
    classDef dto fill:#e2d5f3,stroke:#333,stroke-width:1px
    classDef datastore fill:#ffd6a5,stroke:#333,stroke-width:1px
    classDef config fill:#caffbf,stroke:#333,stroke-width:1px
```
