# sameerean/flight-booking architecture

> Architecture diagram of the GitHub repository sameerean/flight-booking, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sameerean/flight-booking
- Repository: https://github.com/sameerean/flight-booking

## Overview

##### Project type and purpose
- This is a Spring Boot–based REST API application providing flight-booking and lookup services. It is not a full multi-tier web app; rather, it’s a single deployable monolith that exposes REST endpoints for clients (web/mobile) and serves a minimal static UI and Swagger documentation.

##### File structure
- Top-level artifacts: Maven wrapper (`mvnw`, `.mvn`, `pom.xml`), application entrypoint (`Application.java`), and configuration classes (`JpaConfig`, `SwaggerConfig`).
- Layered package layout under `src/main/java/com/dxbair/services/flightbooking`:
- `airport`, `flight`, `passenger`, `booking` packages each with Controller, Service interface + impl, exceptions, and DTO model/converter subpackages.
- `domain/entity` for JPA entities and `domain/repo` for Spring Data JPA repositories.
- `boot/DataLoader` for initial CSV data import.
- `system` for global exception handling.
- Resources: application properties, CSV data files, static `index.html`, and H2 console config.

##### Extract insights from the README
- Primary endpoints: `/bookings?uid={passenger}`, `/bookings/{id}` plus support endpoints under `/airports`, `/flights`, `/passengers`.
- Technologies: Spring MVC (REST), Spring Data JPA, H2 in-memory DB, Swagger UI, JUnit tests.

- Clients (Web UI, Mobile App, CLI/Postman)
- Swagger UI (for API docs & exploratory testing)
- Spring Boot Application
- REST API Layer (Controllers)
- Business Layer (Service interfaces + implementations)
- Data Access Layer (Spring Data JPA Repositories)
- Domain Entities (JPA-annotated)
- Bootstrapping (DataLoader reading CSV → Entities → DB)
- Exception Handling (RestResponseEntityExceptionHandler)
- H2 In-Memory Database (with optional H2 Console as admin UI)
- Static resources (index.html)
b. Relationships & data flow:
1. Client → HTTP request → Controller
2. Controller → calls Service → Service applies business rules → invokes Repository
3. Repository → JPA → H2 Database → returns Entity
4. Service → Model converter → API DTO → Controller → HTTP response → Client
5. On startup: DataLoader reads CSVs → populates repositories → DB.
6. Swagger UI served by Spring Boot → interacts with Controllers.
7. H2 Console served separately → direct DB access.
c. Architectural patterns & principles:
- Layered (Presentation/Controller, Service, Repository)
- DTO conversion (separating domain entities from API models)
- Exception handling via a global handler
- Configuration classes externalize settings (JPA, Swagger)
- In-memory DB for ease of testing/development
d. Key technologies & frameworks:
- Spring Boot (auto-configuration, embedded Tomcat)
- Spring MVC (REST controllers)
- Spring Data JPA + Hibernate
- H2 Database + H2 Console
- Swagger (API documentation)
- Maven build lifecycle

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    subgraph "Clients"
        A1["Web UI / Mobile / CLI"]:::external
    end

    %% Swagger and Static UI
    subgraph "Auxiliary UIs"
        SW["Swagger UI"]:::external
        HU["H2 Console"]:::external
        SI["Static UI (index.html)"]:::external
    end

    %% Controller Layer
    subgraph "Controller Layer"
        AC["AirportController"]:::controller
        FC["FlightController"]:::controller
        PC["PassengerController"]:::controller
        BC["BookingController"]:::controller
    end

    %% Service Layer
    subgraph "Service Layer"
        AS["AirportService"]:::service
        AI["AirportServiceImpl"]:::service
        FS["FlightService"]:::service
        FI["FlightServiceImpl"]:::service
        PS["PassengerService"]:::service
        PI["PassengerServiceImpl"]:::service
        BS["BookingService"]:::service
        BI["BookingServiceImpl"]:::service
    end

    %% Repository Layer
    subgraph "Repository Layer"
        REPO["Spring Data JPA Repositories"]:::repo
        ENT["Domain Entities"]:::repo
    end

    %% Other Components
    DL["DataLoader (CSV import)"]:::service
    EX["Global Exception Handler"]:::external

    %% Database
    DB["H2 In-Memory Database"]:::db

    %% Flows
    A1 -->|"HTTP Request"| AC
    AC -->|"calls"| AI
    FC -->|"calls"| FI
    PC -->|"calls"| PI
    BC -->|"calls"| BI

    AI -->|"uses"| REPO
    FI -->|"uses"| REPO
    PI -->|"uses"| REPO
    BI -->|"uses"| REPO

    REPO -->|"JPA Query"| DB
    DB -->|"Entity returned"| REPO

    AI -->|"converts Entities to DTO"| AC
    FI -->|"converts Entities to DTO"| FC
    PI -->|"converts Entities to DTO"| PC
    BI -->|"converts Entities to DTO"| BC

    AC -->|"throws NotFoundException"| EX
    FC -->|"throws NotFoundException"| EX
    PC -->|"throws NotFoundException"| EX
    BC -->|"throws NotFoundException"| EX

    DL -->|"CSV import"| REPO

    SW -->|"HTTP Request"| AC
    HU -->|"DB Access"| DB
    SI -->|"served by Spring Boot"| A1

    %% Click Events
    click AC "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/airport/AirportController.java"
    click AS "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/airport/AirportService.java"
    click AI "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/airport/AirportServiceImpl.java"
    click FC "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/flight/FlightController.java"
    click FS "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/flight/FlightService.java"
    click FI "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/flight/FlightServiceImpl.java"
    click PC "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/passenger/PassengerController.java"
    click PS "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/passenger/PassengerService.java"
    click PI "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/passenger/PassengerServiceImpl.java"
    click BC "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/booking/BookingController.java"
    click BS "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/booking/BookingService.java"
    click BI "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/booking/BookingServiceImpl.java"
    click DL "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/boot/DataLoader.java"
    click EX "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/system/RestResponseEntityExceptionHandler.java"
    click ENT "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/domain/entity/*.java"
    click REPO "https://github.com/sameerean/flight-booking/blob/master/src/main/java/com/dxbair/services/flightbooking/domain/repo/*.java"

    %% Styles
    classDef controller fill:#D6E9F8,stroke:#31708F,color:#31708F
    classDef service fill:#DFF0D8,stroke:#3C763D,color:#3C763D
    classDef repo fill:#FCF8E3,stroke:#8A6D3B,color:#8A6D3B
    classDef db fill:#EEEEEE,stroke:#333,color:#333
    classDef external fill:#F5F5F5,stroke:#999,color:#555,stroke-dasharray: 5 5
```
