# priyankdalal/rest-tester architecture

> Architecture diagram of the GitHub repository priyankdalal/rest-tester, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/priyankdalal/rest-tester
- Repository: https://github.com/priyankdalal/rest-tester

## Overview

Rest Tester is a local desktop workbench for exploring catalog-described REST APIs and turning requests into regression, data-driven, and load tests. The primary path is user → API Explorer → request execution → API response; the same catalog also feeds specialized test workspaces. The graph preserves the documented Catalog Builder, environments/authentication, and AI drafting branches. Some workspace internals were not sampled, so those connections rely on README statements rather than inferred implementation details.

Main entry points: [`api_tester/main.py`](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/main.py) (Application shell), [`api_tester/client.py`](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/client.py) (HTTP client), [`api_tester/data_runner/ui.py`](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/data_runner/ui.py) (Data Runner), [`api_tester/load_testing/ui.py`](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/load_testing/ui.py) (Load Studio)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_shell["Desktop workspace"]
  node_app["Application shell<br/>[main.py]"]
end

subgraph group_explore["API exploration"]
  node_catalog["API catalog<br/>[catalog.py]"]
  node_explorer["API Explorer<br/>[main.py]"]
  node_request["Request builder<br/>[request_editor.py]"]
  node_client["HTTP client<br/>[client.py]"]
  node_response["Response viewer<br/>[viewers.py]"]
  node_saved[("Saved requests<br/>[saved_requests.py]")]
end

subgraph group_testing["Test execution"]
  node_suite["Test suites<br/>[suite_ui.py]"]
  node_data["Data Runner<br/>[ui.py]"]
  node_csv["CSV mapping<br/>[mapping.py]"]
  node_load["Load Studio<br/>[ui.py]"]
  node_engine["Load engine<br/>[engine.py]"]
  node_contracts["Execution contracts<br/>[models.py]"]
  node_runstore[("Run history<br/>[persistence.py]")]
end

subgraph group_config["Catalog and access"]
  node_builder["Catalog Builder"]
  node_scanner["API scanners<br/>[registry.py]"]
  node_environment["Environments<br/>[environment_ui.py]"]
  node_auth["Authentication<br/>[authentication.py]"]
end

subgraph group_ai["AI assistance"]
  node_ai["AI planning<br/>[workflow_plan.py]"]
  node_provider["AI providers<br/>[provider.py]"]
  node_aiui["AI workspace<br/>[ui.py]"]
end

node_user(("API tester"))
node_api{{"REST API"}}

node_user -->|"opens"| node_app
node_app -->|"presents"| node_explorer
node_explorer -->|"browses"| node_catalog
node_explorer -->|"builds request"| node_request
node_request -->|"sends request"| node_client
node_client -->|"sends HTTP"| node_api
node_api -->|"returns response"| node_response
node_explorer -->|"shows response"| node_response
node_explorer -->|"saves requests"| node_saved
node_app -->|"opens workspace"| node_suite
node_suite -.->|"runs cases"| node_client
node_app -->|"opens workspace"| node_data
node_data -->|"maps rows"| node_csv
node_data -.->|"sends requests"| node_client
node_app -->|"opens workspace"| node_load
node_load -->|"runs scenario"| node_engine
node_engine -->|"records samples"| node_contracts
node_engine -->|"executes requests"| node_client
node_load -.->|"saves runs"| node_runstore
node_app -->|"opens workspace"| node_builder
node_builder -->|"scans services"| node_scanner
node_builder -.->|"creates catalog"| node_catalog
node_app -->|"configures profiles"| node_environment
node_environment -->|"manages credentials"| node_auth
node_client -->|"uses auth strategies"| node_auth
node_app -->|"opens AI workspace"| node_aiui
node_aiui -.->|"requests drafts"| node_ai
node_ai -->|"grounds plans"| node_catalog
node_aiui -.->|"selects provider"| node_provider

click node_app "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/main.py"
click node_catalog "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/catalog.py"
click node_explorer "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/main.py"
click node_request "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/request_editor.py"
click node_client "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/client.py"
click node_response "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/viewers.py"
click node_saved "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/saved_requests.py"
click node_suite "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/suite_ui.py"
click node_data "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/data_runner/ui.py"
click node_csv "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/data_runner/mapping.py"
click node_load "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/load_testing/ui.py"
click node_engine "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/load_testing/engine.py"
click node_contracts "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/execution/models.py"
click node_runstore "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/execution/persistence.py"
click node_builder "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/catalog_builder_ui.py"
click node_scanner "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/scanners/registry.py"
click node_environment "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/environment_ui.py"
click node_auth "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/authentication.py"
click node_ai "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/workflow_plan.py"
click node_provider "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/provider.py"
click node_aiui "https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/ui.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app toneBlue
class node_catalog,node_explorer,node_request,node_client,node_response,node_saved toneAmber
class node_suite,node_data,node_csv,node_load,node_engine,node_contracts,node_runstore,node_user,node_api toneMint
class node_builder,node_scanner,node_environment,node_auth toneRose
class node_ai,node_provider,node_aiui toneIndigo
```

## Components

### Desktop workspace

- [Application shell](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/main.py): `api_tester/main.py`

### API exploration

- [API catalog](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/catalog.py): `api_tester/catalog.py`
- [API Explorer](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/main.py): `api_tester/main.py`
- [Request builder](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/request_editor.py): `api_tester/request_editor.py`
- [HTTP client](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/client.py): `api_tester/client.py`
- [Response viewer](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/viewers.py): `api_tester/viewers.py`
- [Saved requests](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/saved_requests.py): `api_tester/saved_requests.py`

### Test execution

- [Test suites](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/suite_ui.py): `api_tester/suite_ui.py`
- [Data Runner](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/data_runner/ui.py): `api_tester/data_runner/ui.py`
- [CSV mapping](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/data_runner/mapping.py): `api_tester/data_runner/mapping.py`
- [Load Studio](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/load_testing/ui.py): `api_tester/load_testing/ui.py`
- [Load engine](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/load_testing/engine.py): `api_tester/load_testing/engine.py`
- [Execution contracts](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/execution/models.py): `api_tester/execution/models.py`
- [Run history](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/execution/persistence.py): `api_tester/execution/persistence.py`

### Catalog and access

- [Catalog Builder](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/catalog_builder_ui.py): `api_tester/catalog_builder_ui.py`
- [API scanners](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/scanners/registry.py): `api_tester/scanners/registry.py`
- [Environments](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/environment_ui.py): `api_tester/environment_ui.py`
- [Authentication](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/authentication.py): `api_tester/authentication.py`

### AI assistance

- [AI planning](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/workflow_plan.py): `api_tester/ai/workflow_plan.py`
- [AI providers](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/provider.py): `api_tester/ai/provider.py`
- [AI workspace](https://github.com/priyankdalal/rest-tester/blob/main/api_tester/ai/ui.py): `api_tester/ai/ui.py`

### Other components

- **API tester**
- **REST API**

## Connections

- API tester → Application shell: opens (evidence: `README.md`)
- Application shell → API Explorer: presents (evidence: `api_tester/main.py`)
- API Explorer → API catalog: browses (evidence: `README.md`)
- API Explorer → Request builder: builds request (evidence: `README.md`)
- Request builder → HTTP client: sends request (evidence: `README.md`)
- HTTP client → REST API: sends HTTP (evidence: `api_tester/client.py`)
- REST API → Response viewer: returns response (evidence: `README.md`)
- API Explorer → Response viewer: shows response (evidence: `README.md`)
- API Explorer → Saved requests: saves requests (evidence: `README.md`)
- Application shell → Test suites: opens workspace (evidence: `README.md`)
- Test suites → HTTP client: runs cases
- Application shell → Data Runner: opens workspace (evidence: `api_tester/main.py`)
- Data Runner → CSV mapping: maps rows (evidence: `api_tester/data_runner/ui.py`)
- Data Runner → HTTP client: sends requests
- Application shell → Load Studio: opens workspace (evidence: `api_tester/main.py`)
- Load Studio → Load engine: runs scenario (evidence: `api_tester/load_testing/ui.py`)
- Load engine → Execution contracts: records samples (evidence: `api_tester/load_testing/engine.py`)
- Load engine → HTTP client: executes requests (evidence: `api_tester/load_testing/engine.py`)
- Load Studio → Run history: saves runs (evidence: `api_tester/load_testing/ui.py`)
- Application shell → Catalog Builder: opens workspace (evidence: `README.md`)
- Catalog Builder → API scanners: scans services (evidence: `README.md`)
- Catalog Builder → API catalog: creates catalog
- Application shell → Environments: configures profiles (evidence: `api_tester/main.py`)
- Environments → Authentication: manages credentials (evidence: `api_tester/authentication.py`)
- HTTP client → Authentication: uses auth strategies (evidence: `api_tester/client.py`)
- Application shell → AI workspace: opens AI workspace (evidence: `api_tester/main.py`)
- AI workspace → AI planning: requests drafts
- AI planning → API catalog: grounds plans (evidence: `api_tester/ai/workflow_plan.py`)
- AI workspace → AI providers: selects provider
