Этот браузер больше не поддерживается.
Выполните обновление до Microsoft Edge, чтобы воспользоваться новейшими функциями, обновлениями для системы безопасности и технической поддержкой.
Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
В этой статье объясняется, как включить анализ API в Центре API Azure, вручную настроив подсистему подстроки и триггеры. Эти возможности анализируют определения API для соблюдения правил стиля организации, создавая как отдельные, так и сводные отчеты. Анализ API помогает выявлять и исправлять распространенные ошибки и несоответствия в определениях API.
Примечание
В предварительной версии Центр API Azure автоматически настраивает подсистему подстроки и зависимости по умолчанию для анализа API. Если включить самоуправляемый анализ, как описано в этой статье, переопределите эти встроенные функции.
В этом сценарии вы анализируете определения API в центре API с помощью подсистемы подкладки Spectral открытый код. Приложение Функции Azure запускает подсистему подкладок в ответ на события в центре API. Spectral проверяет, соответствуют ли API, определенные в документе спецификации JSON или YAML, правилам в настраиваемом руководстве по стилю API. Создается отчет анализа, который можно просмотреть в центре API.
На следующей схеме показаны шаги по включению встраивание и анализ в центре API.
Разверните приложение Функции Azure, которое запускает подсистему подкладки Spectral в определении API.
Настройте подписку на события в центре API Azure, чтобы активировать приложение-функцию.
Событие активируется путем добавления или замены определения API в центре API.
При получении события приложение-функция вызывает подсистему подкладки Spectral.
Подсистема подкладок проверяет, соответствуют ли API, определенные в определении, руководству по стилю API организации и создает отчет.
Просмотрите отчет по анализу в центре API.
В этой статье приведены два варианта развертывания обработчика подкладок и подписки на события в центре API:
Автоматическое развертывание . Используйте интерфейс командной строки () разработчика Azure дляazd одношагового развертывания инфраструктуры подстраивание. Этот параметр рекомендуется для упрощенного процесса развертывания.
Развертывание вручную. Выполните пошаговые инструкции по развертыванию приложения Функции Azure и настройке подписки на события. Этот параметр рекомендуется, если вы предпочитаете развертывать ресурсы и управлять ими вручную.
spectral:oas набор правил. Чтобы расширить набор правил или создать пользовательские руководства по стилю API, см . репозиторий Spectral GitHub.Центр API в подписке Azure. Если вы еще не создали его, см . краткое руководство. Создание центра API.
Поставщик ресурсов Сетки событий, зарегистрированный в вашей подписке. Если необходимо зарегистрировать поставщик ресурсов Сетки событий, см. статью "Подписка на события, опубликованные партнером с Сетка событий Azure".
При использовании Azure CLI выполните следующее:
Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.
Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.
Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.
Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.
Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
Примечание
az apic для команд требуется apic-extension расширение Azure CLI. Если вы не использовали az apic команды, расширение можно установить динамически при выполнении первой az apic команды или установить расширение вручную. Дополнительные сведения о расширениях Azure CLI.
Дополнительные сведения о последних изменениях и обновлениях см. в заметках о выпускеapic-extension. Для некоторых функций может потребоваться предварительная версия или определенная версия расширения.
Примечание
Примеры команд Azure CLI в этой статье могут выполняться в PowerShell или оболочке bash. Если это необходимо из-за разного синтаксиса переменной, для двух оболочк предоставляются отдельные примеры команд.
В этом разделе приведены автоматизированные действия с помощью интерфейса командной строки разработчика Azure для настройки Функции Azure приложения и подписки на события, которые позволяют выполнять подстроку и анализ в центре API. Вы также можете настроить ресурсы вручную.
Клонируйте репозиторий GitHub и откройте его в Visual Studio Code.
Измените каталог на папку APICenter-Analyzer в репозитории.
В папке resources/rulesetsoas.yaml можно найти файл. Этот файл отражает текущее руководство по стилю API и может быть изменен на основе потребностей и требований организации.
Проверка подлинности с помощью Интерфейса командной строки разработчика Azure и Azure CLI с помощью следующих команд:
azd auth login
az login
Выполните следующую команду, чтобы развернуть инфраструктуру подкладок в подписке Azure.
azd up
Следуйте инструкциям, чтобы указать необходимые сведения о развертывании и параметры, например имя среды и имя центра API. Дополнительные сведения см. в разделе "Запуск примера" с помощью интерфейса командной строки разработчика Azure (azd).
Примечание
Развертывание может занять несколько минут.
После завершения развертывания перейдите в центр API в портал Azure. В меню слева выберите подписки "События">, чтобы просмотреть созданную подписку на события.
Теперь вы можете отправить файл определения API в центр API, чтобы активировать подписку на события и запустить подсистему подкладок.
В этом разделе приведены инструкции по развертыванию вручную, чтобы настроить Функции Azure приложение и подписку на события для включения подстроки и анализа в центре API. Вы также можете использовать интерфейс командной строки разработчика Azure для автоматического развертывания.
Чтобы развернуть приложение Функции Azure, которое запускает функцию подкладки в определениях API:
Клонируйте репозиторий GitHub и откройте его в Visual Studio Code.
В папке resources/rulesetsoas.yaml можно найти файл. Этот файл отражает текущее руководство по стилю API и может быть изменен на основе потребностей и требований организации.
При необходимости запустите приложение-функцию локально, чтобы протестировать его. Дополнительные сведения см . в файле README в репозитории.
Разверните приложение-функцию в Azure. Инструкции см . в кратком руководстве. Создание функции в Azure с помощью TypeScript с помощью Visual Studio Code.
Примечание
Развертывание приложения-функции может занять несколько минут.
Войдите в портал Azure и перейдите в приложение-функцию.
На странице обзора проверьте следующие сведения:
Чтобы включить приложение-функцию для доступа к центру API, настройте управляемое удостоверение для приложения-функции. Ниже показано, как включить и настроить управляемое удостоверение, назначаемое системой, для приложения-функции с помощью портал Azure или Azure CLI.
Теперь, когда управляемое удостоверение включено, назначьте ему роль диспетчера соответствия Центра API Azure для доступа к центру API.
Теперь создайте подписку на события в центре API, чтобы активировать приложение-функцию при отправке или обновлении файла определения API. Ниже показано, как создать подписку на события с помощью портал Azure или Azure CLI.
В портал Azure перейдите в центр API и выберите "События".
На вкладке "Начало работы" выберите функцию Azure.
На странице "Создание подписки на события" сделайте следующее:
Введите описательное имя подписки на событие и выберите схему сетки событий.
В разделе "Сведения о разделе" введите имя раздела системы по вашему выбору.
В типах событий выберите следующие события:
В разделе "Сведения о конечной точке" выберите "Настройка конечной точки" функции > Azure.
На странице "Выбор функции Azure" выберите приложение-функцию и настроенную функцию apicenter-linter. Нажмите кнопку " Подтвердить выбор".
Нажмите кнопку создания.
Перейдите на вкладку "Подписки на события" и нажмите кнопку "Обновить". Убедитесь, что состояние подготовки подписки на событие выполнено успешно.
Примечание
Для распространения подписки на события в приложение-функцию может потребоваться некоторое время.
Чтобы проверить подписку на события, попробуйте отправить или обновить файл определения API, связанный с версией API в центре API. Например, отправьте документ OpenAPI или AsyncAPI. После активации подписки на событие приложение-функция вызывает обработчик подкладок API для анализа определения API.
Чтобы убедиться, что подписка на события была активирована:
Перейдите в центр API и выберите "События " в меню слева.
Перейдите на вкладку "Подписки на события" и выберите подписку на события для приложения-функции.
Просмотрите метрики, чтобы убедиться, что подписка на событие была активирована и что подкладка была вызвана успешно.
Примечание
Для отображения метрик может потребоваться несколько минут.
После анализа определения API подсистема подстроек создает отчет на основе настроенного руководства по стилю API.
Отчет анализа для определения API можно просмотреть в портал Azure. После анализа определения API отчет выводит список ошибок, предупреждений и сведений на основе настроенного руководства по стилю API.
На портале также можно просмотреть сводку отчетов по анализу для всех определений API в центре API.
Чтобы просмотреть отчет по анализу определения API в центре API, выполните следующие действия.
Откроется отчет по анализу API, который отображает определение и ошибки API, предупреждения и сведения на основе настроенного руководства по стилю API. На следующем снимке экрана показан пример отчета по анализу API.
Чтобы просмотреть сводку отчетов по анализу для всех определений API в центре API:
На портале перейдите в центр API.
В меню слева в разделе "Управление" выберите "Анализ API". Появится сводка.
Дополнительные сведения о сетке событий:
Обучение
Схема обучения
Use advance techniques in canvas apps to perform custom updates and optimization - Training
Use advance techniques in canvas apps to perform custom updates and optimization
Сертификация
Изучение, поиск и устранение угроз с помощью Microsoft Sentinel, Microsoft Defender для облака и Microsoft 365 Defender.