Работа со Swagger

Как перейти

  1. Перейдите в Центр мониторинга, раздел Интеграция -> Внешние системы -> Система, для которой необходимо открыть Swagger.

  2. Во вкладке Основные последовательно нажмите левой кнопкой мыши на показатели: Подключение к внешней системе -> Параметры подключения -> Адрес сервиса -> Swagger.

../../_images/swagger_ho_to_open_it_1.png

  1. Перейдите по ссылке в строке Swagger.

../../_images/swagger_ho_to_open_it_2.png

Интерфейс

В Swagger отображаются доступные для выбранной внешей системы методы API и их описание.

../../_images/swagger_structure_rest.png

Методы API-запросов:

  • GET – запрос данных с сервера;

  • POST – создание нового ресурса;

  • PUT – обновление существующего ресурса целиком или создание ресурса, если его не существует;

  • PATCH – частичное обновление ресурса, изменение только указанных полей;

  • DELETE – удаление указанного ресурса.

При нажатии левой кнопкой мыши на строку с методом отобразится более подробная информация:

  • Parameters (Параметры) – что метод ожидает на входе;

  • Request body (Тело запроса) - тело запроса;

  • Responses (Ответы) – тело ответа, коды и описание возможных ответов.

../../_images/swagger_method_example.png

Пример метода без параметров

Метод /getApiData

../../_images/swagger_example_getapidata.png

  • No parameters (Нет параметров) – метод ничего не ожидает на входе:

../../_images/getapidata_parameters.png

  • Responses (Ответы) – при выполнении данного метода возможны ответы с кодами 200, 202, 400, 401, 403, 404, 408, 500, 503:

../../_images/getapidata_responses.png

Пример метода с параметром «ID сообщения»

Метод /{messageId}

../../_images/swagger_example_messageid.png

  • Parameters (Параметры) – на входе метод ожидает ID сообщения:

../../_images/messageid_parameters.png

  • Responses (Ответы) – при выполнении данного метода возможны ответы с кодами 401, 403, 404, 408:

../../_images/messageid_responses.png

Как выполнить запрос

  1. Нажмите левой кнопкой мыши на метод, который необходимо выполнить.

  2. Нажмите кнопку Try it out (Попробовать).

../../_images/how_to_make_a_request_1.png

  1. Если у метода есть параметры, укажите их значения.

  2. Нажмите кнопку Execute (Выполнить).

../../_images/how_to_make_a_request_2.png

  • В блоке Responses отобразится Curl запроса и URL-адрес Request URL:

../../_images/how_to_make_a_request_3.png

  • Ниже отобразится ответ сервера Server response с кодом и деталями:

../../_images/how_to_make_a_request_4.png