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

В этом руководстве объясняется, как расширить инвентаризацию в центре API, добавив сведения о средах и развертываниях API.

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

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

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

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

Предпосылки

• Центр API в подписке Azure. Чтобы создать его, см. Краткое руководство: Создание центра API.
• Один или несколько API, зарегистрированных в центре API. Если у вас нет зарегистрированных API, см. Документация: Регистрация API в вашем перечне API. В этом руководстве используются примеры API, добавленные из предыдущего руководства.

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

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

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

1. Войдите на портал Azure, а затем перейдите в центр API.

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

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

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

   

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

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

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

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

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

2. В меню боковой панели в разделе "Ресурсы" выберите API.

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

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

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

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

   

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

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

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

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

• Дополнительные сведения о Центре API Azure
• Отслеживание зависимостей ресурсов API