Встроенная документация API#
Встроенная интерактивная документация по API компонента Platform Gateway доступна по адресу https://<gateway_host>/api/gateway/v1/docs/.
Эта точка доступа позволяет просматривать доступные методы, параметры запросов, схемы запросов и ответов, а также выполнять тестовые запросы через веб-интерфейс.
Используйте встроенную документацию для изучения структуры ресурсов компонента, проверки параметров запросов и анализа формата ответов.
Пример использования#
Если необходимо получить сведения из журнала действий, и уточнить, какие параметры поддерживает соответствующая точка доступа, выполните следующие действия:
Выполните вход в графическую консоль платформы.
Откройте в браузере точку доступа
https://<gateway_host>/api/gateway/v1/docs/.В списке доступных ресурсов найдите строку
GET /api/gateway/v1/activitystream/.Откройте описание метода, чтобы просмотреть назначение точки доступа, доступные параметры запроса и схему ответа.
При необходимости нажмите кнопку Try it out, чтобы выполнить тестовый запрос через встроенный интерфейс документации.
Проанализируйте пример ответа и используйте полученные сведения при подготовке собственных запросов к API.
Этот пример удобно использовать, когда нужно без обращения к внешней документации быстро уточнить состав параметров запроса, структуру ответа и назначение конкретной точки доступа API.