apidebug/apidebug-agent repository overview

⁠API Debug Agent

apidebug-agent is a lightweight local diagnostics service for inspecting API and protocol behavior from inside your own environment.

It runs as a small HTTP service and executes protocol-specific requests through a consistent API, returning structured results that can include response data, timing, TLS details, compression insights, infrastructure hints, and failure diagnostics.

⁠What It Does

The agent currently supports HTTP execution and analysis, with a framework designed to expand to additional protocols such as WebSocket and MQTT.

Exposed endpoints:

• GET /health
• POST /execute

⁠Key Features

• Local-first execution for private or internal endpoints
• HTTP diagnostics with timing, TLS, certificate, and compression analysis
• Structured JSON responses for UI or automation workflows
• SQLite-backed local persistence
• Rotating log files
• Small Docker image with health checks
• Persistent /data volume for database and logs

⁠Quick Start

docker run -d \
  --name apidebug-agent \
  -p 127.0.0.1:8080:8080 \
  -e APIDEBUG_AGENT_LISTEN=0.0.0.0:8080 \
  -e APIDEBUG_AGENT_DB_PATH=/data/apidebug.sqlite \
  -e APIDEBUG_AGENT_LOG_DIR=/data/logs \
  -v apidebug-agent-data:/data \
  --restart unless-stopped \
  apidebug/apidebug-agent:latest