Skip to content

API Overview

ADP exposes three API domains over HTTP: Debug (stored debug entries), Inspector (live application state), and Ingestion (external data intake).

Base URLs

DomainBase PathPurpose
Debug/debug/apiAccess stored debug entries and SSE stream
Inspector/inspect/apiQuery live application state (routes, config, database, files)
Ingestion/debug/api/ingestAccept debug data from external applications

Response Format

All responses (except SSE and MCP) are wrapped in a standard envelope:

json
{
    "id": "debug-entry-id",
    "data": { ... },
    "error": null,
    "success": true
}

On error, success is false, error contains the error message, and data is null.

Middleware Chain

Every API request passes through:

  1. CorsMiddlewareAppDevPanel\Api\Middleware\CorsMiddlewareCors HTTP middleware.final API · class · implements MiddlewareInterface -- adds permissive CORS headers
  2. IpFilterMiddlewareAppDevPanel\Api\Middleware\IpFilterMiddlewareIp Filter HTTP middleware.final API · class · implements MiddlewareInterface -- validates request IP against allowed IPs (default: 127.0.0.1, ::1)
  3. TokenAuthMiddlewareAppDevPanel\Api\Debug\Middleware\TokenAuthMiddlewareToken Auth HTTP middleware.final API · class · implements MiddlewareInterface -- optional token-based authentication
  4. ResponseDataWrapperAppDevPanel\Api\Debug\Middleware\ResponseDataWrapperClass ResponseDataWrapper.final API · class · implements MiddlewareInterface -- wraps responses in the standard envelope

Inspector endpoints additionally pass through:

  1. InspectorProxyMiddlewareAppDevPanel\Api\Inspector\Middleware\InspectorProxyMiddlewareInspector Proxy HTTP middleware.final API · class · implements MiddlewareInterface -- routes ?service=<name> requests to registered external services

Authentication

By default, the API is restricted to localhost via IP filtering. An optional auth_token can be configured for additional security.

Transports

  • REST -- standard JSON request/response (reference)
  • SSE -- real-time push notifications for new debug entries (reference)
  • MCP -- JSON-RPC 2.0 endpoint for AI assistant integration (reference)

Released under the MIT License.