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

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

  • Статья

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

С помощью анализа API:

  • Центр API Azure автоматически анализирует определения API при добавлении или обновлении определения API. Определения API выстраиваются по умолчанию с набором правил spectral:oas (руководство по стилю API).
  • Отчеты анализа API создаются в портал Azure, показывающие, как определения API соответствуют руководству по стилю.
  • Вы можете использовать расширение Центра API Azure для Visual Studio Code для настройки и тестирования собственного руководства по стилю API локально, а затем развернуть его в центре API.

Внимание

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

Ограничения

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

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

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

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

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

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

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

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

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

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

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

    Совет

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

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

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

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

  1. В Visual Studio Code щелкните значок Центра API Azure на панели действий.
  2. Откройте папку .api-center-rules в корне рабочей папки.
  3. В папке для ресурса центра API откройте ruleset.yml файл.
  4. При необходимости измените или замените содержимое.
  5. Сохраните изменения в файле 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 в вашей организации также могут использовать эту локальную возможность подстраивание, чтобы улучшить определения API перед регистрацией API в центре API.

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

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

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

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

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

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

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

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