# vbyazilim/basichttpdebugger architecture

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

- Interactive diagram: https://gitdiagram.com/vbyazilim/basichttpdebugger
- Repository: https://github.com/vbyazilim/basichttpdebugger

## Overview

##### Main Components

a. HTTP Server Component
- Main server listener (port 9002 by default)
- Request handler functionality
- Raw HTTP request capture capability

b. Request Processing Pipeline
- HTTP Request Parser
- HMAC Validation Component (optional feature)
- Payload Processing Component

c. Output Management System
- Standard Output Handler
- File Output Handler
- Raw HTTP Request Storage

d. Utility Components
- Environment Utils
- String Utils
- Validation Utils
- Writer Utils

##### Component Relationships

**[Incoming HTTP Request] → [HTTP Server (port 9002)]**
- ↓
- [Request Processor]
- ↓
- ┌──────────────┴───────────────┐
- ↓                              ↓
- [HMAC Validator]                [Request Parser]
- ↓                              ↓
- →───────────────┘
- ↓
- [Output Manager]
- ↓
- ┌──────────────┴───────────────┐
- ↓                              ↓
- [Console Output]               [File Output]

##### Additional Elements

- Version information
- External integration points (e.g., webhook sources)
- File storage locations for raw HTTP requests

##### Technical Details to Highlight

- Go runtime environment
- Internal package organization
- Testing components
- Docker support
- GitHub Actions integration

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Container["Docker Container"]
        direction TB
        
        subgraph Server["HTTP Server Layer"]
            direction TB
            HTTPListener["HTTP Listener (Port 9002)"]:::server
            RequestHandler["Request Handler"]:::server
        end

        subgraph Processing["Request Processing Pipeline"]
            direction TB
            ReqProcessor["Request Processor"]:::processor
            HMACValidator["HMAC Validator"]:::validator
            ReqParser["Request Parser"]:::processor
        end

        subgraph Output["Output Management System"]
            direction TB
            OutputMgr["Output Manager"]:::output
            ConsoleOut["Console Output"]:::output
            FileOut["File Output"]:::output
            RawStorage["Raw HTTP Storage"]:::output
        end

        subgraph Utils["Utility Components"]
            direction TB
            EnvUtils["Environment Utils"]:::util
            StringUtils["String Utils"]:::util
            ValidateUtils["Validation Utils"]:::util
            WriterUtils["Writer Utils"]:::util
        end

        subgraph Config["Configuration Layer"]
            direction TB
            EnvVars["Environment Variables"]:::config
            CmdFlags["Command Line Flags"]:::config
        end
    end

    IncomingReq["Incoming HTTP Request"]:::external
    
    %% Flow
    IncomingReq --> HTTPListener
    HTTPListener --> RequestHandler
    RequestHandler --> ReqProcessor
    ReqProcessor --> HMACValidator
    ReqProcessor --> ReqParser
    HMACValidator --> OutputMgr
    ReqParser --> OutputMgr
    OutputMgr --> ConsoleOut
    OutputMgr --> FileOut
    OutputMgr --> RawStorage
    
    %% Utility Connections
    EnvUtils -.- Config
    ValidateUtils -.- HMACValidator
    WriterUtils -.- OutputMgr
    StringUtils -.- ReqParser

    %% Config Connections
    Config -.- Server
    Config -.- Processing
    Config -.- Output

    %% Styling
    classDef server fill:#2374ab
    classDef processor fill:#57a773
    classDef validator fill:#ffd151
    classDef output fill:#8a4fff
    classDef util fill:#949494
    classDef config fill:#cccccc
    classDef external fill:#ffffff,stroke:#333,stroke-width:2px

    %% Click Events
    click HTTPListener "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/httpserver/httpserver.go"
    click RequestHandler "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/httpserver/run.go"
    click ReqProcessor "https://github.com/vbyazilim/basichttpdebugger/blob/main/main.go"
    click ValidateUtils "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/validateutils/validateutils.go"
    click EnvUtils "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/envutils/envutils.go"
    click StringUtils "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/stringutils/stringutils.go"
    click WriterUtils "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/writerutils/writerutils.go"
    click OutputMgr "https://github.com/vbyazilim/basichttpdebugger/blob/main/internal/writerutils/writerutils.go"
    click Container "https://github.com/vbyazilim/basichttpdebugger/tree/main/Dockerfile"
```
