Создайте и настройте портал Центра API

В этой статье показано, как установить и настроить портал API Center, веб-сайт под управлением Azure для обнаружения API, серверов MCP и связанных ресурсов в вашем центре API.

Портал Центра API поддерживает и упрощает работу разработчиков, использующих и создавающих API в организации. Пользователи с доступом могут:

• Поиск API по имени или использованию семантического поиска с помощью искусственного интеллекта.
• Фильтрация API по типам, этапу жизненного цикла и другим свойствам.
• Просмотр сведений и определений API, включая конечные точки, методы, параметры и форматы ответа.
• Загрузите определения API на свой компьютер или откройте в Visual Studio Code.
• Попробуйте использовать API с помощью ключа API или проверки подлинности OAuth 2.0.

Предпосылки

• Центр API в подписке Azure. Если вы еще не создали его, см Краткое руководство: Создайте ваш центр API.

• Разрешения на создание регистрации приложения в клиенте Microsoft Entra, связанном с подпиской Azure, и разрешения на предоставление доступа к данным в центре API.

Настройка доступа к порталу Центра API

Сначала выберите способ доступа пользователей к порталу Центра API. Вы можете настроить Microsoft Entra ID в качестве поставщика удостоверений или разрешить анонимный доступ.

Вариант 1. Настройка проверки подлинности Microsoft Entra ID для портала (рекомендуется)

Чтобы настроить Microsoft Entra ID в качестве поставщика удостоверений, сначала настройте регистрацию приложения в клиенте Microsoft Entra ID. Регистрация приложения позволяет порталу Центра API получать доступ к данным из центра API от имени пользователя, вошедшего в систему.

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

Автоматическая настройка регистрации приложения (рекомендуется)

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

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

2. В меню боковой панели выберите Потребление>Параметры портала.

3. На вкладке Access выберите Configure Entra ID.

4. На странице Настройка входа пользователя с помощью Microsoft Entra ID выберите Configure.

5. На вкладке Access нажмите кнопку "Сохранить и опубликовать".

Если вам нужно получить доступ к регистрации приложения позже, его можно найти на портале в разделе Регистрация приложений. Приложение называется следующим форматом: <api-center-name-apic-aad>.

Настройка регистрации приложения вручную

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

1. На портале Azure перейдите к Microsoft Entra ID>Manage>Регистрация приложений.

2. Выберите + Создать регистрацию.

3. На странице Регистрация приложения задайте необходимые значения следующим образом.

   1. Установите Имя на осмысленное название, например api-center-portal
   2. В разделе "Поддерживаемые типы учетных записей" выберите только учетные записи в этом каталоге организации (<имя> каталога — один клиент).
   3. В URI перенаправления выберите одностраничное приложение (SPA) и задайте URI. Введите URI развертывания портала Центра API в следующей форме: https://<service-name>.portal.<location>.azure-apicenter.ms. Замените <service name> и <location> на название вашего центра API и местоположение, где он развернут, например, https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Выберите Зарегистрировать.

Настройка дополнительных URI перенаправления для расширения VS Code

При включении представления портала Центра API в расширении Visual Studio Code для Центра API также настройте следующие URI перенаправления в регистрации приложения:

1. На портале Azure перейдите к регистрации приложения.

2. На странице "Управление>проверкой подлинности " выберите "Добавить платформу " и выберите мобильные и классические приложения.

3. Настройте следующие три настраиваемых URI перенаправления.
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Замените <application-client-id> идентификатором приложения (клиента) этого приложения. Это значение можно найти на странице обзора регистрации приложения.

Вариант 2. Разрешить анонимный доступ к порталу

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

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

2. В меню боковой панели выберите Потребление>Параметры портала.

3. На вкладке Access выберите "Разрешить анонимный доступ".

   

4. Чтобы настроить доступ, выберите "Подтвердить" и "Включить".

Просмотр портала

После настройки доступа откройте портал Центра API, выбрав портал Центра API на странице параметров портала или посетите страницу параметров портала :
https://<service-name>.portal.<location>.azure-apicenter.ms

(Замените <service-name> и <location> на имя вашего центра API и место развертывания.)

По умолчанию домашняя страница портала является общедоступной. Если Microsoft Entra ID настроен для доступа, пользователи должны выбрать Sign-in для доступа к API. Дополнительные сведения о настройке доступа пользователей см. в разделе Включение входа в портал для пользователей и групп Microsoft Entra.

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

Разрешить вход на портал пользователям и группам Microsoft Entra

Если Microsoft Entra ID настроен для доступа к порталу, пользователи должны войти на портал Центра API для доступа к API. Чтобы активировать вход, назначьте роль Azure API Center Data Reader пользователям или группам в вашей организации, в рамках вашего API центра.

Подробные требования и действия по назначению роли пользователям и группам см. в разделе Назначение ролей Azure с помощью портала Azure. Краткие действия:

1. На портале Azure перейдите в центр API.
2. В боковом меню выберите Элемент управления доступом (IAM)>+ Добавить назначение ролей.
3. В области добавления назначения ролей задайте следующие значения:
   1. На странице Role найдите и выберите Читатель данных центра API Azure. Выберите Далее.
   2. На странице "Участники" в разделе "Назначение доступа" выберите "Пользователь", "Группа" или "Субъект-служба>" и "Выбрать участников".
   3. На странице "Выбор участников" найдите и выберите пользователей или группы, чтобы назначить роль. Нажмите кнопку Выбрать , а затем — Далее.
   4. Просмотрите назначение роли и нажмите кнопку "Проверить и назначить".

После настройки доступа к порталу пользователи могут войти на портал и просмотреть API в центре API.

Настройка портала Центра API

В следующих разделах показано, как настроить интерфейс портала Центра API для пользователей. Для более обширной настройки вы также можете самостоятельно разместить портал Центра API.

Профиль сайта

На вкладке "Профиль сайта " параметров портала Центра API при необходимости укажите настраиваемое имя, отображаемое в верхней строке портала.

Видимость API

На странице настроек API>данных о потреблении можно управлять тем, какие API доступны для обнаружения (видны) пользователям портала API Center. Параметры видимости применяются ко всем пользователям портала Центра API и связанным функциям потребления, которые используют API плоскости данных Центра API.

Чтобы сделать только определенные API видимыми, добавьте условия фильтра для API на основе встроенных свойств. Например, отображение API только определенных типов, таких как REST или GraphQL, или на основе определенных форматов спецификаций, таких как OpenAPI.

Семантический поиск

Если включить семантический поиск на вкладке "Семантический поиск", портал Центра API дополняет базовый поиск API на основе имен с помощью ИИ-поиска, основанного на именах API, описаниях и, при необходимости, настраиваемых метаданных. Семантический поиск доступен только в стандартном плане.

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

Чтобы использовать поиск с помощью ИИ при входе на портал Центра API, выберите поле поиска, выберите "Поиск с помощью ИИ" и введите запрос.

Пользовательские метаданные

На вкладке метаданных при необходимости выберите настраиваемые свойства метаданных , которые необходимо предоставить в сведениях API и семантического поиска.

Взносы

На вкладке "Вклад" при необходимости введите URL-адрес репозитория Git, чтобы пользователи могли предоставлять общий доступ к своим ресурсам с помощью репозитория. Например, посетители могут просматривать репозиторий или создавать PR для добавления либо обновления плагинов, агентов или навыков.

После ввода URL-адреса репозитория Git портал отображает кнопку "Участие " на домашней странице. Посетители могут выбрать эту кнопку, чтобы открыть репозиторий на новой вкладке браузера.

Включение доступа к тестовой консоли для API

Параметры пользователя можно настроить для детальной авторизации доступа к API и определенным версиям в центре API. Например, настройте определенные версии API для использования ключей API для проверки подлинности и создайте политику доступа, которая позволяет определенным пользователям проходить проверку подлинности с помощью этих ключей.

Политики доступа также применяются к возможности "Попробовать этот API" для API на портале Центра API, гарантируя, что только пользователи портала с соответствующей политикой доступа могут использовать тестовую консоль для этих версий API. Узнайте больше об авторизации доступа к API.

Порталы управления API и центра API

Службы Azure API Management и Azure Api Center предоставляют порталы для разработчиков для обнаружения и использования API:

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

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

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

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

• Включение и просмотр центра Azure API в Visual Studio Code
• Самостоятельное размещение портала Центра API