Skip to content

OpenAPI спецификация

Для интеграций доступна машинно-читаемая спецификация API в формате OpenAPI 3.0.

Файл в проекте: api/openapi.yaml
Версия: OpenAPI 3.0.3

Что дает этот файл:

  • единый контракт API (эндпоинты, параметры, схемы ответов, auth)
  • импорт в Swagger UI / Redoc для интерактивной документации
  • генерация SDK/клиентов и автотестов для интеграции

Быстрый старт (локально):

# Swagger Editor / генераторы
# импортируйте файл api/openapi.yaml

Важно: спецификация отражает публичное API и должна обновляться вместе с изменениями обработчиков в папке api/.