Изменение в структуре API¶
Триггер предназначен для контроля изменений в инвентаризированной структуре API. Можно выбрать один или несколько типов изменений: новый, удаленный или измененный эндпоинт.
Сценарий использования: триггер полезен, когда необходимо своевременно узнать о появлении неизвестного эндпоинта, удалении ранее используемого метода или изменении структуры API в конкретном приложении.
Пример триггера изменения структуры API¶
-
Создайте триггер с типом Изменение в структуре API.
По умолчанию в форме создания триггера уже указано условие.
-
Укажите название и описание – это поможет быстрее ориентироваться в общем списке триггеров.
-
Выберите тип изменений:
- Новый эндпоинт – событие срабатывает, когда в API добавляется ранее отсутствовавший эндпоинт.
- Изменён эндпоинт – событие означает, что уже существующий эндпоинт претерпел какие-либо модификации, но сам факт его наличия сохранился. Примеры изменений: изменение параметров запроса, изменение тела запроса или ответа, изменение HTTP-статусов ответов.
-
Задайте фильтр.
Область отслеживания можно ограничить приложениями и хостами. Доступны два режима:- Следить только за выбранными элементами
- Следить за всеми, кроме выбранных.
При необходимости отдельно задается критерий учета чувствительных данных PII.
-
Добавьте реакцию.
Укажите, как система будет реагировать при обнаружении событий, попадающих под условия выше.
-
Нажмите Создать.
После срабатывания триггер передает уведомление через webhook-интеграцию, указанную в блоке Реакция при срабатывании, триггер будет отображаться в разделе Триггеры.