Сравнение спецификаций¶

ПроAPI Структура автоматически идентифицирует API Shadow, Orphan и Zombie, сравнивая загруженную вами спецификацию с текущим трафиком.

Требования к загружаемой спецификации¶

Проверьте спецификацию перед загрузкой, она должна соответствовать следующим требованиям:

• Формат OpenAPI v3 JSON или YAML.

• Указана версия экземпляра спецификации.
  

  
   

  Пример

  
  

  
  
                  {
  
                      "openapi": "3.0.1",
  
                      "info": {
  
                      "title": "Open API spec",
  
                      "description":"API Discovery",
  
                      "version": "1.0.1"
  
                  }
  
              }
  
          

  
  

Ежечасное сравнение rogue API¶

Вы можете загрузить свою спецификацию, чтобы выполнить немедленное сравнение ее содержимого с эндпоинтами, обнаруженными ПО ПроAPI Структура на текущий момент. Со временем могут измениться две вещи:

• Ваше фактическое использование API (изменения будут обнаружены с помощью ПО ПроAPI Структура).

• Ваша собственная спецификация (могут появиться новые версии).

Чтобы настроить постоянный мониторинг rogue API, у вас есть возможность сравнения на почасовой основе. Чтобы использовать эту опцию, спецификация должна быть загружена с URL-адреса. Сама спецификация будет обновляться перед каждым сравнением.

Как настроить сравнение rogue API на почасовой основе:

1. Перейдите в раздел Спецификация API в Консоли управления Вебмониторэкс.

2. Нажмите Загрузить спецификацию.

3. Выберите спецификацию для загрузки.

4. Установите параметры сравнения:

   • Приложения и хосты - будут сравниваться только эндпоинты, связанные с выбранными приложениями / хостами. Если вы выберете Сравнить со всеми текущими и будущими обнаруженными в хостами приложений, то в сравнение будут включены все хосты (выбранных приложений), известные сейчас, и все хосты, которые будут обнаружены в будущем.

     Вы можете изменить настройки сравнения в любой момент - после этого сравнение будет выполнено заново с новыми результатами.

   • Выберите загрузку с URL-адреса. При необходимости вы можете указать токен для аутентификации.

   • Оставьте выбранной опцию Регулярно выполнять сравнение (она включена по умолчанию).
   

5. Запустите загрузку.

По завершении загрузки количество rogue API (shadow, orphan и zombie) будет отображаться для каждой спецификации в списке Спецификация API.

Также в разделе ПроAPI Структура будут отображаться rogue API. Используйте фильтр Rogue API, чтобы увидеть только API shadow, orphan и / или zombie, связанные с выбранными сравнениями, и отфильтровать оставшиеся эндпоинты.

В информации о таких эндпоинтах, в разделе Конфликты со спецификациями, будет указана спецификация, с помощью которой были обнаружены shadow/zombie/orphan.

Поиск rogue API путем однократного сравнения¶

Вы можете загрузить свою спецификацию, чтобы выполнить немедленное однократное сравнение ее содержимого с эндпоинтами, обнаруженными Структурой API на данный момент: для этого в настройках сравнения выберите загрузку с локального компьютера или снимите флажок Выполнять регулярное сравнение для спецификации, загруженной с URL.

Обратите внимание:

• Вы можете перезапустить сравнение в любой момент через меню спецификаций → Перезапустить сравнение.

• Вы можете скачать ранее загруженную спецификацию через Спецификация API → окно сведений о спецификации → Скачать спецификацию.

Версии спецификаций и zombie API¶

В отличие от shadow и orphan API, zombie API требуют сравнения различных версий спецификаций:

• В случае регулярного сравнения по часам просто укажите новую версию URL-адреса, где вы размещаете свою спецификацию. Она будет обрабатываться по почасовому графику или немедленно, если вы выберете вариант Перезапустить сравнение в меню спецификаций.

• В случае, когда регулярное сравнение не используется:

  • При загрузке с URL-адреса измените этот URL-адрес на новый или разместите новый контент на том же URL-адресе.
  • При загрузке с локального компьютера откройте диалоговое окно спецификации в Консоли управления Вебмониторэкс, затем загрузите новый файл или тот же файл с новым содержимым.

  Затем сохраните спецификацию и в ее меню выберите Перезапустить сравнение.

Работа с несколькими спецификациями¶

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

В разделе ПроAPI Структура используйте фильтр Сравнить с... для выбора спецификаций к сравнению — для них rogue API будут выделены специальными метками в столбце Безопасность.