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

Включение анализа API в центре API — управление Майкрософт

  • Статья

В этой статье объясняется, как включить анализ API в Центре API Azure без необходимости управлять им самостоятельно (предварительная версия). Анализ API предлагает возможности подстраивание для анализа определений API в центре API вашей организации. Linting гарантирует, что определения API соответствуют правилам стиля организации, создавая как отдельные, так и сводные отчеты. Используйте анализ API для выявления и исправления распространенных ошибок и несоответствий в определениях API.

Внимание

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

В этом сценарии:

  1. Добавьте набор правил подстроки (руководство по стилю API) в центре API с помощью расширения Visual Studio Code для Центра API Azure.
  2. Центр API Azure автоматически запускает подкладку при добавлении или обновлении определения API. Он также активируется для всех определений API при развертывании набора правил в центре API.
  3. Просмотрите отчеты об анализе API в портал Azure, чтобы узнать, как определения API соответствуют руководству по стилю.
  4. При необходимости настройте набор правил для API вашей организации. Протестируйте настраиваемый набор правил локально перед развертыванием в центре API.

Ограничения

  • В настоящее время анализируются только документы спецификации OpenAPI в формате JSON или YAML.
  • По умолчанию можно включить анализ с spectral:oas помощью набора правил. Дополнительные сведения о встроенных правилах см. в репозитории Spectral GitHub.
  • В настоящее время вы настраиваете один набор правил и применяется ко всем определениям OpenAPI в центре API.
  • Существуют ограничения на максимальное количество проанализированных определений API. Для завершения анализа может потребоваться несколько минут до 24 часов.

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

Включение анализа API с помощью Visual Studio Code

Чтобы включить анализ API с помощью набора правил подстраивание по умолчанию, выполните следующие действия.

  1. В Visual Studio Code откройте папку, которая будет использоваться для управления наборами правил для Центра API Azure.

  2. Щелкните значок Центра API Azure на панели действий.

  3. В области Центра API разверните ресурс центра API, в котором можно включить анализ API.

  4. Щелкните правой кнопкой мыши "Правила" и выберите "Включить анализ API".

    Снимок экрана: включение подстраивание и анализ API в Visual Studio Code.

Сообщение уведомляет вас после успешного включения анализа API. Папка центра API создается в .api-center-rulesкорневом каталоге рабочей папки. Папка центра API содержит следующее:

  • ruleset.yml Файл, определяющий стиль API по умолчанию, используемый обработчиком подкладок.
  • Папка functions с примером пользовательской функции, которую можно использовать для расширения набора правил.

С включенным анализом подсистема подкладок анализирует определения API в центре API на основе набора правил по умолчанию и создает отчеты по анализу API.

Просмотр отчетов по анализу API

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

Чтобы просмотреть сводку по анализу в центре API, выполните следующие действия.

  1. На портале перейдите в центр API.

  2. В меню слева в разделе "Управление" выберите "Анализ API". Появится сводка.

    Снимок экрана: сводка по анализу API на портале.

  3. При необходимости выберите значок отчета анализа API для определения API. Появится отчет по анализу API определения, как показано на следующем снимке экрана.

    Снимок экрана: отчет об анализе API на портале.

    Совет

    Вы также можете просмотреть отчет по анализу API, выбрав "Анализ " в строке меню определения API.

Настройка набора правил

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

Чтобы настроить или заменить набор правил, выполните следующие действия.

  1. В Visual Studio Code откройте папку .api-center-rules в корне рабочей папки.
  2. В папке для ресурса центра API откройте ruleset.yml файл.
  3. При необходимости измените или замените содержимое.
  4. Сохраните изменения в файле ruleset.yml.

Набор правил тестирования локально

Перед развертыванием настраиваемого набора правил в центре API проверьте его локально. Расширение Центра API Azure для Visual Studio Code обеспечивает встроенную поддержку спецификации API с помощью Spectral.

  1. В Visual Studio Code используйте сочетание клавиш CTRL+SHIFT+P , чтобы открыть палитру команд.

  2. Введите Центр API Azure: задайте активное руководство по стилю API и нажмите клавишу ВВОД.

  3. Выберите "Выбрать локальный файл " и укажите настроенный ruleset.yml файл. Нажмите клавишу ВВОД.

    Этот шаг делает настраиваемый набор правил активным руководством по стилю API для подстраивание.

Теперь при открытии файла определения API на основе OpenAPI локальная операция подстраивание автоматически активируется в Visual Studio Code. Результаты отображаются встроенными в редакторе и в окне "Проблемы " (просмотр > проблем или CTRL+SHIFT+M).

Снимок экрана: определение API в Visual Studio Code.

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

Развертывание набора правил в центре API

Чтобы развернуть настраиваемый набор правил в центре API, выполните следующие действия.

  1. В Visual Studio Code щелкните значок Центра API Azure на панели действий.
  2. В области Центра API разверните ресурс центра API, в котором вы настроили набор правил.
  3. Щелкните правой кнопкой мыши правила и выберите пункт "Развернуть правила" в Центре API.

Сообщение уведомляет вас после успешного развертывания правил в центре API. Модуль подкладок использует обновленный набор правил для анализа определений API.

Чтобы просмотреть результаты подстраивание с обновленным набором правил, просмотрите отчеты анализа API на портале.

Связанный контент