Включение и просмотр представления портала Центра API Azure — расширение VS Code

2025-05-30

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

Подсказка

Расширение Visual Studio Code предоставляет дополнительные возможности для разработчиков API, имеющих разрешения на управление центром API Azure. Например, разработчики API могут регистрировать API в центре API непосредственно или с помощью конвейеров CI/CD. Подробнее

Предпосылки

Администраторы центра API

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

Для разработчиков приложений

Расширение Центра API Azure для Visual Studio Code

Следующие расширения Visual Studio Code являются необязательными.

Расширение Microsoft Kiota — для создания клиентов API
GitHub Copilot и GitHub Copilot Chat, предоставленные с доступом к GitHub Copilot, чтобы использовать инструменты языковой модели в режиме агента для изучения API.

Действия для администраторов центра API для предоставления доступа к представлению портала Центра API

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

Создание регистрации приложения Microsoft Entra

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

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

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

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

На портале Azure перейдите в центр API.
В меню слева выберите портал Центра API>Параметры.
На вкладке "Поставщик удостоверений" выберите "Начать настройку".
Нажмите кнопку "Сохранить и опубликовать".

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

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

На портале Azure перейдите к Microsoft Entra ID>регистрации приложений.
Выберите +Создать регистрацию.
На странице "Регистрация приложения" задайте значения следующим образом:
1. Установите Name на осмысленное имя, например, 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 перенаправления в регистрации приложения:

На портале Azure перейдите к регистрации приложения.
На странице "Управление>проверкой подлинности " выберите "Добавить платформу " и выберите мобильные и классические приложения.
Настройте следующие три настраиваемых URI перенаправления.
https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

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

Корпоративные разработчики должны войти с помощью учетной записи Майкрософт, чтобы перейти на портал вашего API-центра. При необходимости добавьте или пригласите разработчиков в клиент Microsoft Entra.

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

Это важно

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

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

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

Примечание.

Чтобы упростить настройку доступа для новых пользователей, рекомендуется назначить роль группе Microsoft Entra и настроить правило динамического членства в группах. Дополнительные сведения см. в статье "Создание или обновление динамической группы" в идентификаторе Microsoft Entra.

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

Примечание.

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

Шаги для корпоративных разработчиков по доступу к интерфейсу портала центра API

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

Подключение к центру API

В Visual Studio Code в строке действий слева выберите центр API.
Используйте сочетание клавиш CTRL+SHIFT+P , чтобы открыть палитру команд. Введите Центр API Azure: соединитесь с Центром API и нажмите клавишу ввод.
Ответьте на запросы для ввода следующих сведений:
1. URL-адрес среды выполнения вашего центра API в формате <service name>.data.<region>.azure-apicenter.ms (не добавляйте префикс https://). Пример: contoso-apic.data.eastus.azure-apicenter.ms. Этот URL-адрес среды выполнения отображается на странице обзора центра API в представлении портала Azure.
2. Идентификатор приложения (клиента) из регистрации приложения, настроенного администратором в предыдущем разделе.
3. Идентификатор каталога (клиента) из регистрации приложения, которую настроил администратор в предыдущем разделе.
Подсказка

Администратор центра API должен предоставить предыдущие сведения о подключении разработчикам или предоставить прямую ссылку в следующем формате:
vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

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

Обнаружение и использование API в представлении портала Центра API

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

Экспорт документа спецификации API— экспорт спецификации API из определения и его скачивание в виде файла
Создание клиента API . Использование расширения Microsoft Kiota для создания клиента API для любимого языка
Создание Markdown — создание документации по API в формате Markdown
Документация по OpenAPI . Просмотрите документацию по определению API и попробуйте выполнить операции в пользовательском интерфейсе Swagger (доступно только для определений OpenAPI).

Использование средств языковой модели

Разработчики с доступом к представлению портала Центра API могут добавлять средства языковой модели Центра API для использования в режиме агента GitHub Copilot. Дополнительные сведения об использовании средств в режиме агента.

Средства Центра API можно использовать в режиме агента для поиска api и версий API, определений и спецификаций API, развертываний и многого другого использования запросов естественного языка.

Чтобы добавить и использовать средства языкового режима Центра API в режиме агента GitHub Copilot:

Подключитесь к центру API , как описано в предыдущем разделе.
Откройте чат GitHub Copilot в Visual Studio Code.
Задайте для агента режим GitHub Copilot Chat.
Щелкните значок "Сервис" в окне чата.
Выберите один или несколько инструментов Центра API, которые будут доступны в чате.
Введите запрос в окне чата, чтобы использовать доступные средства. Рассмотрим пример.
```
Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
```
Просмотрите ответы из чата GitHub Copilot. Продолжайте беседу, чтобы уточнить результаты или задать дальнейшие вопросы.

Устранение неполадок

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

Проверьте параметры регистрации приложения, настроенной в идентификаторе Microsoft Entra. Подтвердите значения идентификатора приложения (клиента) и идентификатора каталога (арендатора) в регистрации приложения, а также URL-адрес среды выполнения центра API. Затем снова настройте подключение к центру API.