Разработчики могут взаимодействовать с веб-сервисом через программные запросы, используя стандарты описания API. Интерфейс API соответствует спецификации OpenAPI 3 версии и имеет Swagger интерфейс для разработки и отладки.

Общее описание API: Спецификация OpenAPI предоставляет четкое и понятное описание вашего API, включая доступные эндпоинты, методы (GET, POST, PUT, DELETE и другие), параметры запроса, заголовки, коды ответов и типы данных.

Структура спецификации:

• Версия: Определяет версию спецификации.
• Информация: Содержит метаданные о вашем API, такие как название, версия и описание.
• Хост и база пути: Указывает базовый URL и контекстный путь API.
• Эндпоинты: Описывает каждый доступный ресурс API, его методы и возможные параметры и ответы.

Swagger UI предоставляет визуальный интерфейс, где можно исследовать API, видеть доступные эндпоинты и выполнять тестовые запросы прямо из браузера. Можно вводить необходимые параметры, отправлять запросы и просматривать ответы, что упрощает понимание работы API и тестирование его функций. Если спецификация API обновляется, Swagger UI автоматически отражает эти изменения, предоставляя актуальную информацию.