Документация API

Документация API

Документация REST API и WebSocket интерфейса для CodeGraph.

Справочник API

Документ Описание
REST API Полный справочник HTTP API с примерами
WebSocket API Интерфейс потоковой передачи в реальном времени

Быстрый старт

Запуск API-сервера

python -m src.api.cli run --host 0.0.0.0 --port 8000

Получение токена аутентификации

curl -X POST http://localhost:8000/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "password"}'

Использование токена

curl http://localhost:8000/api/v1/scenarios \
  -H "Authorization: Bearer <token>"

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

Все конечные точки (кроме /health) требуют аутентификации:

JWT-токен

curl -H "Authorization: Bearer <token>" \
  http://localhost:8000/api/v1/scenarios

API-ключ

curl -H "X-API-Key: <api-key>" \
  http://localhost:8000/api/v1/scenarios

Конечные точки API

Категория Метод Endpoint Описание
Auth POST /api/v1/auth/token Получить JWT-токен
Scenarios GET /api/v1/scenarios Список сценариев
Chat POST /api/v1/chat Отправить сообщение
Query POST /api/v1/query/execute Выполнить запрос
Review POST /api/v1/review/patch Проверить патч
Health GET /api/v1/health Проверка здоровья

Интерактивная документация

После запуска сервера:

  • Swagger UI: http://localhost:8000/api/docs
  • ReDoc: http://localhost:8000/api/redoc

Связанная документация