Поделиться через

Отладка политик управления API Azure в Visual Studio Code

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: Разработчик

Политики в службе управления API Azure предоставляют мощные возможности, которые помогают издателям API решать такие задачи, как проверка подлинности, авторизация, регулирование, кэширование и преобразование. Политика — это коллекция правил, которые выполняются последовательно над запросом или ответом API.

В этой статье объясняется, как выполнять отладку политик Управления API с помощью расширения Управления API Azure для Visual Studio Code.

Необходимые компоненты

Ограничения и границы

  • Эта функция использует встроенную подписку на все доступ (уровень обслуживания) (отображаемое имя "Встроенная подписка на все доступ") для отладки.

Внимание

  • Управление API больше не поддерживает подписки для трассировки или Заголовок Ocp-Apim-Trace.
  • Для повышения безопасности API теперь можно включить трассировку на уровне отдельного API путем получения ограниченного по времени маркера с помощью REST API Управление API и передачи маркера в запросе шлюзу. Дополнительные сведения см. в разделе "Включение трассировки API".
  • Следите за включением трассировки, так как она может предоставлять конфиденциальную информацию в данных трассировки. Убедитесь, что у вас есть соответствующие меры безопасности для защиты данных трассировки.

Запуск сеанса отладки

  1. Запустите Visual Studio Code.
  2. Перейдите к расширению API Management в разделе расширений Azure.
  3. Найдите экземпляр API Management для отладки.
  4. Найдите API и операцию для отладки.
  5. Щелкните операцию правой кнопкой мыши и выберите команду Начать отладку политики.

На этом этапе расширение попытается инициировать и установить сеанс отладки с помощью шлюза API Management.

запуск отладки

Отправьте тестовый запрос.

При установке сеанса отладки расширение откроет новый редактор, позволяющий создать и отправить в эту операцию тестовый HTTP-запрос с использованием расширения клиента REST.

Вы увидите, что в запрос уже добавлен заголовок OCP-Apim-Debug. Этот заголовок является обязательным, и для него должно быть задано значение ключа подписки уровня службы с полным доступом, что позволяет активировать функции отладки в шлюзе API Management.

Измените HTTP-запрос в редакторе в соответствии со своим сценарием тестирования. Затем нажмите кнопку Отправить запрос, чтобы отправить тестовый запрос шлюзу API Management.

отправка тестового запроса

Политики отладки

После отправки тестового HTTP-запроса расширение откроет окно отладки, в котором отобразятся действующие политики для данной операции, и выполнение будет остановлено на первой действующей политике.

отладка политик

В рамках конвейера политик можно выполнять политики по одной или установить точку останова на определенной политике и перейти непосредственно к ней.

На панели Переменные можно проверять значения созданных системой и созданных пользователем переменных. На панели Точки останова можно просмотреть список всех настроенных точек останова. На панели Стек вызовов можно увидеть текущую область действующей политики.

При возникновении ошибки во время выполнения политики вы увидите подробные сведения о ней в той политике, где она произошла.

exceptions

Совет

После завершения не забудьте выйти из сеанса отладки, нажав кнопку Остановить.

Следующие шаги