# bayunugroho2022/dio-request-inspector architecture

> Architecture diagram of the GitHub repository bayunugroho2022/dio-request-inspector, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bayunugroho2022/dio-request-inspector
- Repository: https://github.com/bayunugroho2022/dio-request-inspector

## Overview

##### Project Type and Purpose
- This is a Flutter plugin package (“dio_request_inspector”) that hooks into the Dio HTTP client to intercept, log, secure, filter, and display HTTP activity in a built-in UI.
- It exposes a NavigatorObserver and a Dio interceptor, plus a widget wrapper, to integrate seamlessly into any Flutter app.

##### File-Structure Analysis
- Top level
– example/  : demo Flutter app showing how to integrate the plugin
– lib/     : the plugin code itself
– test/   : unit tests for core functionality
– .github/, README.md, etc. – CI, contribution guidelines, documentation
- lib/src/ breakdown
– common/ : utilities (copy, enum types, extensions, helpers, parser, local storage)
– interceptor.dart : logic to create a DioInterceptor that captures requests, responses, errors
– model/ : data classes for HTTP request, response, error, activity, form-data
– page/  : UI layer
- main/ : entry widget (DioRequestInspectorMain) that wraps the app and installs the NavigatorObserver
- dashboard/ : list view of all captured activities (filters, search, summary toggle)
- detail/ : per-activity detail view (headers, JSON beautification, copy/share)
- lib/dio_request_inspector.dart
– Public API: exposes `DioRequestInspector`, `navigatorObserver`, `DioRequestInspectorMain` wrapper

##### README Insights
- Core feature list: intercept + log + secure (password) + filter + search + share + beautify + UI
- Integration steps:
1. wrap your root widget with `DioRequestInspectorMain`
2. `DioRequestInspector.navigatorObserver` to `navigatorObservers`
3. Plugin’s interceptor to your Dio instance

##### Diagramming the Architecture
a. Main Components
– Integration Layer
- DioRequestInspectorMain widget (root)
- NavigatorObserver (for long-press detection, hide/show UI)
- PasswordProtection (optional)
– Interceptor Layer
- DioInterceptor (intercepts request/response/error events from Dio)
– Data Layer
- Storage Manager (in-memory or persisted via common/storage.dart)
- Parser & Helpers (format JSON, extract form-data)
– Model Layer
- HTTPActivity (ties request + response + error)
- HttpRequest, HttpResponse, HttpError, FormData
– UI Layer
- DashboardPage (list, filters, search, summary)
- DetailPage (per-entry details, copy/share)
- Widgets (dot indicator, item rows/columns, password dialog)
– External Dependencies
- Dio HTTP client
- Flutter MaterialApp + Navigator
b. Relationships & Data Flow
– App code → wraps with DioRequestInspectorMain → installs NavigatorObserver
– App code → Dio instance → plugin’s interceptor → onRequest/onResponse/onError callbacks
– Interceptor → Storage Manager → emits events (Activity list updated)
– UI (DashboardPage) subscribes to storage events → renders list
– User taps an item → navigates to DetailPage with selected HTTPActivity
– User actions (copy/share) → Common helpers invoked
c. Architectural Patterns/Principles
– Layered Architecture: separation of Interceptor, Data, Model, UI
– Observer Pattern: storage broadcasts changes to UI
– Dependency Injection (NavigatorObserver, interceptor)
– Single-Responsibility for parser, storage, model, UI widgets
d. Technologies & Frameworks
– Flutter (UI)
– Dio (HTTP client)
– Provider / built-in setState or Streams (implicit state management)
– JSON parsing (dart:convert + custom parser)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Integration Layer
    subgraph "Integration Layer"
        direction TB
        HostApp["Host App\nMaterialApp & Dio Instance"]:::integration
        Entrypoint["Plugin Entrypoint\nDioRequestInspector"]:::integration
        MainWidget["DioRequestInspectorMain\n(widget wrapper)"]:::integration
        NavObserver["NavigatorObserver"]:::integration
    end

    %% Interceptor Layer
    subgraph "Interceptor Layer"
        direction TB
        Interceptor["DioInterceptor"]:::core
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Storage["Storage Manager"]:::core
        Parser["Parser"]:::core
        Helpers["Helpers\n(JSON beautifier, copy/share)"]:::core
        CopyUtil["Copy Utility"]:::core
        Enums["Enums"]:::core
        Exts["Extensions"]:::core
    end

    %% Model Layer
    subgraph "Model Layer"
        direction TB
        HTTPActivity["HTTPActivity"]:::model
        Req["HttpRequest"]:::model
        Resp["HttpResponse"]:::model
        Err["HttpError"]:::model
        FormData["FormData"]:::model
    end

    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Dashboard["DashboardPage"]:::ui
        DotIndicator["DotIndicatorWidget"]:::ui
        ItemResp["ItemResponseWidget"]:::ui
        PasswordDialog["PasswordProtectionDialog"]:::ui
        Detail["DetailPage"]:::ui
        ItemCol["ItemColumnWidget"]:::ui
        ItemRow["ItemRowWidget"]:::ui
        SearchBar["SearchAppBar"]:::ui
        SearchHighlight["SearchHighlight"]:::ui
        Resources["AppColors"]:::ui
    end

    %% Example & Tests
    subgraph "Example App"
        direction TB
        ExampleSettings["Demo Settings Integration"]:::integration
        ExampleMain["Example App Entrypoint"]:::integration
    end

    subgraph "Tests"
        direction TB
        Tests["Core Functionality Tests"]:::integration
    end

    %% Relationships
    HostApp --> MainWidget
    HostApp --> Entrypoint
    HostApp --> NavObserver
    HostApp --> Interceptor
    MainWidget --> NavObserver
    Interceptor --> Storage
    Storage --> Dashboard
    Dashboard --> Detail
    NavObserver --> Dashboard
    Req --> HTTPActivity
    Resp --> HTTPActivity
    Err --> HTTPActivity
    FormData --> HTTPActivity
    HTTPActivity --> Storage
    Parser --> Storage
    Helpers --> Dashboard
    Helpers --> Detail
    CopyUtil --> Helpers
    Enums --> Helpers
    Exts --> Helpers

    %% Example & Tests Relations
    ExampleMain --> MainWidget
    ExampleSettings --> Entrypoint
    Tests --> Interceptor

    %% Click Events
    click MainWidget "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/main/main_page.dart"
    click NavObserver "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/dio_request_inspector.dart"
    click Entrypoint "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/dio_request_inspector.dart"
    click Interceptor "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/interceptor.dart"
    click Storage "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/storage.dart"
    click Parser "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/parser.dart"
    click Helpers "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/helpers.dart"
    click CopyUtil "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/copy.dart"
    click Enums "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/enum.dart"
    click Exts "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/common/extensions.dart"
    click HTTPActivity "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/model/http_activity.dart"
    click Req "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/model/http_request.dart"
    click Resp "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/model/http_response.dart"
    click Err "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/model/http_error.dart"
    click FormData "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/model/form_data.dart"
    click Dashboard "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/dashboard/dashboard_page.dart"
    click DotIndicator "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/dashboard/widget/dot_indicator_widget.dart"
    click ItemResp "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/dashboard/widget/item_response_widget.dart"
    click PasswordDialog "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/dashboard/widget/password_protection_dialog.dart"
    click Detail "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/detail/detail_page.dart"
    click ItemCol "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/detail/widgets/item_column.dart"
    click ItemRow "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/detail/widgets/item_row.dart"
    click SearchBar "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/detail/widgets/search_app_bar.dart"
    click SearchHighlight "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/detail/widgets/search_highlight.dart"
    click Resources "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/lib/src/page/resources/app_color.dart"
    click ExampleSettings "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/example/lib/dio_request_inspector_setting.dart"
    click ExampleMain "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/example/lib/main.dart"
    click Tests "https://github.com/bayunugroho2022/dio-request-inspector/blob/master/test/awesome_inspector_test.dart"

    %% Styles
    classDef integration fill:#D0E8FF,stroke:#333,stroke-width:1px
    classDef core fill:#FFE0B2,stroke:#333,stroke-width:1px
    classDef ui fill:#C8E6C9,stroke:#333,stroke-width:1px
    classDef model fill:#E0E0E0,stroke:#333,stroke-width:1px
```
