Skip to content

Обзор API

ADP предоставляет три домена API по HTTP: Debug (сохраненные записи отладки), Inspector (текущее состояние приложения) и Ingestion (прием данных от внешних приложений).

Базовые URL

ДоменБазовый путьНазначение
Debug/debug/apiДоступ к сохраненным записям отладки и SSE-потоку
Inspector/inspect/apiЗапрос текущего состояния приложения (маршруты, конфигурация, БД, файлы)
Ingestion/debug/api/ingestПрием отладочных данных от внешних приложений

Формат ответа

Все ответы (кроме SSE и MCP) оборачиваются в стандартный конверт:

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

При ошибке success равен false, error содержит сообщение об ошибке, а data равен null.

Цепочка middleware

Каждый API-запрос проходит через:

  1. IpFilter -- проверка IP запроса по списку разрешенных (по умолчанию: 127.0.0.1, ::1)
  2. CorsAllowAll -- добавление разрешающих CORS-заголовков
  3. ResponseDataWrapper -- оборачивание ответа в стандартный конверт
  4. DebugHeaders -- добавление заголовков X-Debug-Id и X-Debug-Link

Для эндпоинтов Inspector дополнительно:

  1. InspectorProxyMiddlewareAppDevPanel\Api\Inspector\Middleware\InspectorProxyMiddlewareInspector Proxy HTTP middleware.final API · class · implements MiddlewareInterface -- перенаправление запросов с ?service=<name> к зарегистрированным внешним сервисам

Аутентификация

По умолчанию API доступен только с localhost через IP-фильтрацию. Для дополнительной безопасности можно настроить auth_token.

Транспорты

  • REST -- стандартные JSON запросы/ответы (справка)
  • SSE -- push-уведомления о новых записях отладки в реальном времени (справка)
  • MCP -- JSON-RPC 2.0 эндпоинт для интеграции с AI-ассистентами (справка)

Выпущено под лицензией MIT.