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

Руководство. Добавление сред и развертываний для API

  • Статья

Расширение инвентаризации в центре API путем добавления сведений о средах и развертываниях API.

  • Среда представляет расположение, в котором может быть развернута среда выполнения API, например платформа управления API.

  • Развертывание — это расположение (адрес), где пользователи могут получить доступ к API.

Общие сведения об API, развертываниях и других сущностях, которые можно инвентаризации в Центре API Azure, см . в основных понятиях.

В этом руководстве вы узнаете, как использовать портал для:

  • Добавление сведений о средах API
  • Добавление сведений о развертываниях API

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

Добавление среды

Используйте центр API для отслеживания сред API реального мира. Например, вы можете использовать Azure Управление API или другое решение для распространения, защиты и мониторинга некоторых API. Или вы можете напрямую обслуживать некоторые API с помощью вычислительной службы или кластера Kubernetes.

Здесь вы добавите сведения о вымышленной среде Azure Управление API в центр API. Если вы предпочитаете, добавьте сведения о одной из существующих сред. Вы настроите встроенные метаданные и все пользовательские метаданные, определенные в предыдущем руководстве.

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

  2. В меню слева в разделе "Ресурсы" выберите "Среды>+ Новая среда".

  3. На странице "Новая среда" добавьте следующие сведения. Если вы ранее определили пользовательскую строку бизнес-метаданных или другие метаданные, назначенные средам, вы увидите их в нижней части страницы.

    Параметр значение Описание
    Название среды Введите мое тестирование. Имя, выбранное для среды.
    Идентификация После ввода предыдущего заголовка Центр API Azure создает этот идентификатор, который можно переопределить. Имя ресурса Azure для среды.
    Тип среды Выберите "Тестирование " в раскрывающемся списке. Тип среды для API.
    Description Введите описание (необязательно). Описание среды.
    Сервер
    Тип При необходимости выберите Azure Управление API из раскрывающегося списка. Используемый тип решения по управлению API.
    URL-адрес портала управления При необходимости введите URL-адрес для интерфейса управления, например https://admin.contoso.com URL-адрес интерфейса управления для среды.
    Переход
    URL-адрес портала разработки При необходимости введите URL-адрес для портала разработчика, например https://developer.contoso.com URL-адрес интерфейса для подключения разработчика в среде.
    Инструкции При необходимости выберите "Изменить " и введите инструкции по подключению в стандартном markdown. Инструкции по подключению к API из среды.
    Бизнес Если вы добавили эти настраиваемые метаданные, при необходимости выберите из раскрывающегося списка, например ИТ. Пользовательские метаданные, определяющие подразделение, которое управляет средой.

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

  4. Нажмите кнопку создания. Среда отображается в списке сред.

Добавление развертывания

Центр API также может помочь каталогизировать развертывания API — среды выполнения, в которых развернуты отслеживаемые API.

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

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

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

  3. Выберите API, например API конференции.

  4. На странице API конференции в разделе "Сведения" выберите "Развертывания>+ Добавить развертывание".

  5. На странице "Добавление развертывания" добавьте следующие сведения. Если вы ранее определили пользовательскую строку бизнес-метаданных или другие метаданные, назначенные средам, вы увидите их в нижней части страницы.

    Параметр значение Описание
    Заголовок Введите развертывание версии 1. Имя, выбранное для развертывания.
    Идентификация После ввода предыдущего заголовка Центр API Azure создает этот идентификатор, который можно переопределить. Имя ресурса Azure для развертывания.
    Description Введите описание (необязательно). Описание развертывания.
    Среда Выберите в раскрывающемся списке, например "Мое тестирование", или при необходимости выберите "Создать". Новая или существующая среда, в которой развернута версия API.
    Определение Выберите или добавьте файл определения для версии API конференции. Файл определения API.
    URL-адрес среды выполнения Введите базовый URL-адрес, например https://api.contoso.com. Базовый URL-адрес среды выполнения для API в среде.
    Бизнес Если вы добавили эти настраиваемые метаданные, при необходимости выберите из раскрывающегося списка, например ИТ. Пользовательские метаданные, определяющие бизнес-подразделение, которое управляет API в среде.

    Снимок экрана: добавление развертывания API на портале.

  6. Нажмите кнопку создания. Развертывание отображается в списке развертываний.

В этом руководстве вы узнали, как использовать портал для:

  • Добавление сведений о средах API
  • Добавление сведений о развертываниях API

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