# sari3l/requests architecture

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

- Interactive diagram: https://gitdiagram.com/sari3l/requests
- Repository: https://github.com/sari3l/requests

## Overview

##### Project Type and Purpose
- This is a Go‑library (“requests”) that simplifies HTTP calls (GET, POST, etc.), similar to Python’s requests.
- It provides a high‑level API (api.go, adapters.go) for building requests, sending them, parsing responses, and adding extensions (auth, data, hooks).

##### File Structure
Top‑level modules:
- api.go, adapters.go       → Public API entry points
- request.go, response.go   → Core request/response abstractions
- prepareRequest.go         → Prepares net/http.Request from options
- sessions.go               → Manages persistent configuration (cookies, headers)
- utils.go                  → Shared helper functions
- go.mod, go.sum            → Module definitions
Subdirectories:
- ext/                      → Extension hooks (Auth, Data, custom hook registration)
- internal/decoder          → Response decoding (JSON, XML)
- internal/parser           → XPath parsing
- internal/processbar       → Progress bar for downloads
- internal/tracer           → HTTP tracing support
- tools/                    → Stand‑alone utilities (chromedp, downloader, hash, random, report)
- types/                    → Data types (Auth, basic, bearer, extension args)
- template/                 → Report generation templates
- docs/                     → Markdown and static site files for documentation

##### README for Additional Insights
- Usage example shows core flow: types.BasicAuth → requests.Post → ext.Auth → ext.Data → resp.Json()
- Emphasizes extensibility via ext package and types for auth/data

##### Elements
- Clear Labels: name each module/file group, e.g., “Response Handler (response.go)”
– Blue rectangles for core library modules
– Green for extension/plugin layer
– Orange for internal utilities

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client
    ClientApp["Client Application"]:::client

    %% Public API Layer
    subgraph "Public API Layer"
        API1["api.go"]:::core
        API2["adapters.go"]:::core
    end

    %% Core Library
    subgraph "Core Library"
        subgraph "Request Abstractions"
            Req["request.go"]:::core
        end
        subgraph "Response Handler"
            Resp["response.go"]:::core
        end
        subgraph "Request Builder & Session Manager"
            Prep["prepareRequest.go"]:::core
            Sess["sessions.go"]:::core
        end
        Util["utils.go"]:::core
    end

    %% Extensions Engine
    subgraph "Extensions Engine" 
        Ext1["extension.go"]:::ext
        Ext2["hooks.go"]:::ext
    end

    %% Internal Utilities
    subgraph "Internal Utilities"
        PB["processbar.go"]:::util
        TR["tracer.go"]:::util
    end

    %% Decoding & Parsing
    subgraph "Decoding & Parsing"
        Dec["decode.go"]:::core
        Pars["xpath.go"]:::core
    end

    %% HTTP Transport
    HTTP["net/http.Client"]:::external

    %% External Services
    EHS["External HTTP Services"]:::external

    %% Tools & Reporting
    subgraph "Tools & Reporting"
        T1["chromedp.go"]:::tool
        T2["cloudflare.go"]:::tool
        T3["convert.go"]:::tool
        T4["downloader.go"]:::tool
        T5["fingerprint.go"]:::tool
        T6["hash.go"]:::tool
        T7["random.go"]:::tool
        T8["report.go"]:::tool
        Template["report.tpl"]:::tool
        Docs["docs/"]:::optional
    end

    %% Main Flow
    ClientApp -->|"calls"| API1
    ClientApp -->|"calls"| API2
    API1 --> Req
    API2 --> Req
    Req --> Prep
    Util --> Prep
    Sess --> HTTP
    Prep --> HTTP
    HTTP --> EHS
    EHS --> Resp
    Resp --> Dec
    Dec --> Pars
    Pars --> ClientApp

    %% Extensions Hooks
    Ext1 -.-> Prep
    Ext2 -.-> Req
    Ext2 -.-> Resp

    %% Internal Utilities Integration
    TR -.-> HTTP
    Prep -.-> PB

    %% Tools & Reporting (optional)
    ClientApp -.-> T1
    ClientApp -.-> T2
    ClientApp -.-> T3
    ClientApp -.-> T4
    ClientApp -.-> T5
    ClientApp -.-> T6
    ClientApp -.-> T7
    ClientApp -.-> T8
    ClientApp -.-> Template
    ClientApp -.-> Docs

    %% Click Events
    click API1 "https://github.com/sari3l/requests/blob/main/api.go"
    click API2 "https://github.com/sari3l/requests/blob/main/adapters.go"
    click Req "https://github.com/sari3l/requests/blob/main/request.go"
    click Resp "https://github.com/sari3l/requests/blob/main/response.go"
    click Prep "https://github.com/sari3l/requests/blob/main/prepareRequest.go"
    click Sess "https://github.com/sari3l/requests/blob/main/sessions.go"
    click Util "https://github.com/sari3l/requests/blob/main/utils.go"
    click Ext1 "https://github.com/sari3l/requests/blob/main/ext/extension.go"
    click Ext2 "https://github.com/sari3l/requests/blob/main/ext/hooks.go"
    click Dec "https://github.com/sari3l/requests/blob/main/internal/decoder/decode.go"
    click Pars "https://github.com/sari3l/requests/blob/main/internal/parser/xpath.go"
    click PB "https://github.com/sari3l/requests/blob/main/internal/processbar/processbar.go"
    click TR "https://github.com/sari3l/requests/blob/main/internal/tracer/tracer.go"
    click T1 "https://github.com/sari3l/requests/blob/main/tools/chromedp.go"
    click T2 "https://github.com/sari3l/requests/blob/main/tools/cloudflare.go"
    click T3 "https://github.com/sari3l/requests/blob/main/tools/convert.go"
    click T4 "https://github.com/sari3l/requests/blob/main/tools/downloader.go"
    click T5 "https://github.com/sari3l/requests/blob/main/tools/fingerprint.go"
    click T6 "https://github.com/sari3l/requests/blob/main/tools/hash.go"
    click T7 "https://github.com/sari3l/requests/blob/main/tools/random.go"
    click T8 "https://github.com/sari3l/requests/blob/main/tools/report.go"
    click Template "https://github.com/sari3l/requests/blob/main/template/report.tpl"
    click Docs "https://github.com/sari3l/requests/tree/main/docs/"

    %% Styles
    classDef client fill:#f9f,stroke:#333,stroke-width:1px
    classDef core fill:#bbdefb,stroke:#0d47a1,stroke-width:1px
    classDef ext fill:#c8e6c9,stroke:#2e7d32,stroke-width:1px
    classDef util fill:#ffe0b2,stroke:#ef6c00,stroke-width:1px
    classDef external fill:#cfd8dc,stroke:#455a64,stroke-width:1px
    classDef tool fill:#e0e0e0,stroke:#757575,stroke-width:1px,stroke-dasharray: 5 5
    classDef optional fill:none,stroke-dasharray: 5 5,stroke:#999,fill:#fafafa
```
