# bhanjan03/apiautomation architecture

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

- Interactive diagram: https://gitdiagram.com/bhanjan03/apiautomation
- Repository: https://github.com/bhanjan03/apiautomation

## Overview

##### Project Type and Purpose
- This is an open-source Java-based API Automation Framework.
- Primary goal: enable writing, executing, mocking, and reporting REST API tests via RestAssured, TestNG, WireMock, Owner (config), and ExtentReports.

##### File Structure
- Top-level:
- pom.xml (Maven build & dependencies)
- README.md (architecture & usage)
- extent-test-report/ (generated HTML reports)
- src/main/java/com/apiautomationframework:
- config/ (Owner interfaces, ConfigFactory)
- constants/, enums/, exceptions/ (framework metadata & errors)
- models/pojo & models/builders (request/response data models & builder patterns)
- reports/ (ExtentReports integration: manager, logger, initialization)
- utils/ (AuthTokenManager, FakerUtils)
- src/test/java/com/apiautomationframework/tests:
- TestNG test classes (LoginTest, AdminTest, AccountTest, UserProfileTest)
- ParallelTestRunner/TestRunner
- src/test/java/com/apiautomationframework/wiremock:
- WireMock-based mock tests
- src/test/resources/config:
- config.properties (environment, credentials, timeout, headless, etc.)

##### Main Components
a. Test Runner Layer
- TestNG runner (ParallelTestRunner/TestRunner)
- BaseTest (report setup/teardown)
b. Test Cases
- LoginTest, AdminTest, AccountTest, UserProfileTest, APIWireMockTest
- Use custom annotations (@Authors, @CategoryType)
c. Configuration Manager
- FrameworkConfig/ConfigFactory (Owner)
- config.properties
d. API Client
- RestAssured module invoking HTTP calls
- AuthTokenManager for token handling
e. Mocking Service
- WireMock server for stubbed endpoints
f. Data Modeling
- POJOs (LoginRequest, LoginResponse, User)
- Builder classes (RequestBuilder, ResponseBuilder, TokenManager)
g. Reporting Engine
- ExtentReport, ExtentManager, ExtentLogger
- Generates extent-test-report HTML
h. Utilities
- FakerUtils for test data generation

##### Relationships & Data Flow
1. Test Runner initializes → loads configuration via ConfigFactory → BaseTest initializes ExtentReports
2. Test case begins → retrieves test data via FakerUtils or POJO builders
3. Test case invokes RestAssured client → uses AuthTokenManager if auth is needed
4. HTTP request goes to either:
– Real target API (via URL in config.properties)
– WireMock stub (for isolated/mock scenarios)
5. Response → mapped to POJO via ResponseBuilder → validated/asserted in test
6. ExtentLogger logs each step/result → ExtentReport updated
7. After all tests, ExtentReport flushes to extent-test-report/

##### Architectural Patterns & Principles
- Layered architecture: Test Runner → Tests → Client → Services (Real vs. Mock) → Reporting
- Builder Pattern for constructing requests/responses
- Factory Pattern for configuration (ConfigFactory)
- Custom annotations for metadata (authors/categories)
- Parallel execution for performance (TestNG parallel runner)

##### Essential Elements to Capture
- Separation of concerns: config vs. data modeling vs. execution vs. reporting
- Data flow: from test definition → HTTP request → response mapping → assertions
- Extensibility: builder patterns, custom annotations, WireMock hooks
- Parallelism: TestNG parallel runner interacting with shared report manager

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Configuration Manager"
        CF["ConfigFactory"]:::config
        FC["FrameworkConfig"]:::config
        CP["config.properties"]:::config
    end

    subgraph "Test Runner Layer"
        PTR["ParallelTestRunner"]:::tests
        TR["TestRunner"]:::tests
        BT["BaseTest"]:::tests
    end

    subgraph "Test Cases"
        LT["LoginTest"]:::tests
        AT["AdminTest"]:::tests
        ACT["AccountTest"]:::tests
        UP["UserProfileTest"]:::tests
    end

    subgraph "API Client & Auth"
        ATM["AuthTokenManager"]:::module
        RA["RestAssured Client"]:::module
    end

    subgraph "Services"
        API["Real API Endpoint"]:::external
        WM["WireMock Server"]:::external
    end

    subgraph "Data Modeling"
        RB["RequestBuilder"]:::module
        RSB["ResponseBuilder"]:::module
        TM["TokenManager"]:::module
        LReq["LoginRequest"]:::module
        LRes["LoginResponse"]:::module
        UPOJO["User"]:::module
    end

    subgraph "Reporting Engine"
        ER["ExtentReport"]:::report
        EM["ExtentManager"]:::report
        EL["ExtentLogger"]:::report
    end

    subgraph "Utilities"
        FU["FakerUtils"]:::module
    end

    CF -->|loads config| PTR
    CF -->|loads config| TR
    PTR --> BT
    TR --> BT

    PTR --> LT
    PTR --> AT
    PTR --> ACT
    PTR --> UP

    LT --> FU
    LT --> RB
    LT --> RA
    AT --> RA
    ACT --> RA
    UP --> RA

    RA --> ATM
    RA --> API
    RA --> WM

    API --> RSB
    WM --> RSB
    RSB --> LT
    RSB --> AT
    RSB --> ACT
    RSB --> UP

    LT --> EL
    AT --> EL
    ACT --> EL
    UP --> EL
    EL --> ER
    ER -->|"flush reports"| extent-test-report

    BT --> EM
    BT --> ER
    BT --> EL

    classDef config fill:#ADD8E6,stroke:#000;
    classDef tests fill:#90EE90,stroke:#000;
    classDef module fill:#ADD8E6,stroke:#000;
    classDef external fill:#FFA500,stroke:#000;
    classDef report fill:#FFFF00,stroke:#000;

    click PTR "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/ParallelTestRunner.java"
    click TR "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/TestRunner.java"
    click BT "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/BaseTest.java"
    click LT "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/LoginTest.java"
    click AT "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/AdminTest.java"
    click ACT "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/AccountTest.java"
    click UP "https://github.com/bhanjan03/apiautomation/blob/master/src/test/java/com/apiautomationframework/tests/UserProfileTest.java"
    click CF "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/config/ConfigFactory.java"
    click FC "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/config/FrameworkConfig.java"
    click CP "https://github.com/bhanjan03/apiautomation/blob/master/src/test/resources/config/config.properties"
    click ATM "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/utils/AuthTokenManager.java"
    click RB "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/builders/RequestBuilder.java"
    click RSB "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/builders/ResponseBuilder.java"
    click TM "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/builders/TokenManager.java"
    click LReq "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/pojo/LoginRequest.java"
    click LRes "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/pojo/LoginResponse.java"
    click UPOJO "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/models/pojo/User.java"
    click ER "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/reports/ExtentReport.java"
    click EM "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/reports/ExtentManager.java"
    click EL "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/reports/ExtentLogger.java"
    click FU "https://github.com/bhanjan03/apiautomation/blob/master/src/main/java/com/apiautomationframework/utils/FakerUtils.java"
```
