# vgakilan/api-test architecture

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

- Interactive diagram: https://gitdiagram.com/vgakilan/api-test
- Repository: https://github.com/vgakilan/api-test

## Overview

api-test is a Windows PowerShell CLI for running configuration-driven API requests. The user selects an interface and environment, supplies optional overrides and payloads, and the CLI sends the request through curl.exe, checks the HTTP status, and displays redacted output; saving is optional. The graph reflects README-documented responsibilities and capabilities. Source excerpts were unavailable, so internal call ownership and unmentioned implementation details cannot be verified.

Main entry points: [`api.ps1`](https://github.com/vgakilan/api-test/blob/main/api.ps1) (CLI entry point), [`lib/Invoke-Curl.ps1`](https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1) (Curl execution), [`config.toml.example`](https://github.com/vgakilan/api-test/blob/main/config.toml.example) (Configuration), [`.env.example`](https://github.com/vgakilan/api-test/blob/main/.env.example) (Credentials)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Request Inputs"]
  node_configuration["Configuration"]
  node_credentials["Credentials<br/>[.env.example]"]
  node_interfaces["Interface definitions"]
  node_payloads["Request payloads<br/>[valid.json]"]
end

subgraph group_execution["Request Execution"]
  node_entry["CLI entry point<br/>[api.ps1]"]
  node_resolution["Config and payload helpers<br/>[Common.ps1]"]
  node_curlrunner["Curl execution<br/>[Invoke-Curl.ps1]"]
end

subgraph group_outputs["Results and Output"]
  node_status["HTTP status checks<br/>[Invoke-Curl.ps1]"]
  node_redaction["Output redaction<br/>[Redaction.ps1]"]
  node_reports["Markdown reports<br/>[Invoke-Curl.ps1]"]
end

node_user(("CLI user"))
node_curl["curl.exe"]
node_api{{"Target API"}}
node_terminal["Terminal output"]
node_bat["bat.exe"]

node_user -->|"runs"| node_entry
node_user -->|"configures"| node_configuration
node_user -->|"sets credentials"| node_credentials
node_user -->|"selects interface"| node_interfaces
node_user -->|"supplies payload"| node_payloads
node_entry -->|"uses helpers"| node_resolution
node_entry -->|"runs requests"| node_curlrunner
node_curlrunner -->|"executes"| node_curl
node_curl -->|"sends request"| node_api
node_curlrunner -->|"checks status"| node_status
node_entry -->|"sanitizes output"| node_redaction
node_entry -->|"displays results"| node_terminal
node_entry -->|"saves optionally"| node_reports
node_entry -.->|"formats optionally"| node_bat

click node_entry "https://github.com/vgakilan/api-test/blob/main/api.ps1"
click node_configuration "https://github.com/vgakilan/api-test/blob/main/config.toml.example"
click node_credentials "https://github.com/vgakilan/api-test/blob/main/.env.example"
click node_interfaces "https://github.com/vgakilan/api-test/tree/main/interface"
click node_payloads "https://github.com/vgakilan/api-test/blob/main/interface/create-user/payloads/valid.json"
click node_resolution "https://github.com/vgakilan/api-test/blob/main/lib/Common.ps1"
click node_curlrunner "https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1"
click node_status "https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1"
click node_redaction "https://github.com/vgakilan/api-test/blob/main/lib/Redaction.ps1"
click node_reports "https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1"

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_configuration,node_credentials,node_interfaces,node_payloads,node_user toneBlue
class node_entry,node_resolution,node_curlrunner toneAmber
class node_status,node_redaction,node_reports,node_api toneMint
class node_curl,node_terminal,node_bat toneIndigo
```

## Components

### Request Inputs

- [Configuration](https://github.com/vgakilan/api-test/blob/main/config.toml.example): `config.toml.example`
- [Credentials](https://github.com/vgakilan/api-test/blob/main/.env.example): `.env.example`
- [Interface definitions](https://github.com/vgakilan/api-test/tree/main/interface): `interface`
- [Request payloads](https://github.com/vgakilan/api-test/blob/main/interface/create-user/payloads/valid.json): `interface/create-user/payloads/valid.json`

### Request Execution

- [CLI entry point](https://github.com/vgakilan/api-test/blob/main/api.ps1): `api.ps1`
- [Config and payload helpers](https://github.com/vgakilan/api-test/blob/main/lib/Common.ps1): `lib/Common.ps1`
- [Curl execution](https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1): `lib/Invoke-Curl.ps1`

### Results and Output

- [HTTP status checks](https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1): `lib/Invoke-Curl.ps1`
- [Output redaction](https://github.com/vgakilan/api-test/blob/main/lib/Redaction.ps1): `lib/Redaction.ps1`
- [Markdown reports](https://github.com/vgakilan/api-test/blob/main/lib/Invoke-Curl.ps1): `lib/Invoke-Curl.ps1`

### Other components

- **CLI user**
- **curl.exe**
- **Target API**
- **Terminal output**
- **bat.exe**

## Connections

- CLI user → CLI entry point: runs (evidence: `README.md`)
- CLI user → Configuration: configures (evidence: `README.md`)
- CLI user → Credentials: sets credentials (evidence: `README.md`)
- CLI user → Interface definitions: selects interface (evidence: `README.md`)
- CLI user → Request payloads: supplies payload (evidence: `README.md`)
- CLI entry point → Config and payload helpers: uses helpers (evidence: `README.md`)
- CLI entry point → Curl execution: runs requests (evidence: `README.md`)
- Curl execution → curl.exe: executes (evidence: `README.md`)
- curl.exe → Target API: sends request (evidence: `README.md`)
- Curl execution → HTTP status checks: checks status (evidence: `README.md`)
- CLI entry point → Output redaction: sanitizes output (evidence: `README.md`)
- CLI entry point → Terminal output: displays results (evidence: `README.md`)
- CLI entry point → Markdown reports: saves optionally (evidence: `README.md`)
- CLI entry point → bat.exe: formats optionally (evidence: `README.md`)
