Проектирование и создание API с помощью плагина Центра API для GitHub Copilot в Azure

Подключаемый модуль API Center для GitHub Copilot для Azure ускоряет проектирование и разработку новых API за счет использования запросов на естественном языке. С помощью искусственного интеллекта, доступного через плагин Центра API и расширение VS Code, вы можете легко описать ваш API и быстро создать спецификацию OpenAPI для разработки API, которая соответствует стандартам вашей организации. Создав соответствующую спецификацию, вы можете зарегистрировать API в центре API.

Предварительные условия

• Visual Studio Code

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

• Один или несколько центров API в подписке Azure. Центр API можно создать с помощью расширения Центра API Azure или других средств.

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

• GitHub Copilot для Azure — генерация файлов спецификаций OpenAPI с помощью плагина Центра API Azure для GitHub Copilot для Azure

Настройка расширения

1. Установите расширение Центра API Azure для Visual Studio Code из Visual Studio Code Marketplace. Установите другие расширения по мере необходимости.

   Примечание.

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

2. В Visual Studio Code в строке действий слева выберите центр API.

   

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

Запрос к агенту @azure

Выполните следующие действия, чтобы создать спецификацию OpenAPI с помощью запросов естественного языка с помощью GitHub Copilot для Azure:

1. При желании задайте активное руководство по стилю API в расширении Центра API Azure. Используйте сочетание клавиш CTRL+SHIFT+P, чтобы открыть палитру команд. Введите Центр API Azure: установите руководство по стилю API, выберите его и нажмите ВВОД.

   Если не задано руководство по стилю, используется набор правил по умолчанию spectral:oas . Узнайте больше о проверке спецификаций API с помощью расширения Центра API.

2. На панели чата отправьте запрос на естественном языке @azure агенту, чтобы описать, что делает API. Пример:

   @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.
   

   Copilot работает СИ, поэтому возможны сюрпризы и ошибки. Дополнительные сведения см. в часто задаваемых вопросых о Copilot.

   Агент отвечает с помощью документа спецификации OpenAPI.

   

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

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

   Совет

   Эффективные запросы ориентированы на бизнес-требования API, а не сведения о реализации. Более короткие запросы иногда работают лучше, чем более длинные.

4. Когда он соответствует вашим требованиям, сохраните созданную спецификацию OpenAPI в файл.

Зарегистрируйте API в вашем центре API

Используйте расширение Центра API Azure для VS Code, чтобы зарегистрировать API в центре API из созданного файла спецификации. После регистрации API можно использовать расширение для просмотра документации API, создания HTTP-клиента, а также для дальнейших изменений и анализа.

1. В VS Code нажмите кнопку «Зарегистрировать API в центре API» на панели чата или выберите Центр API Azure: Зарегистрировать API в окне команд.

2. Выберите Вручную.

3. Выберите центр API для регистрации API.

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

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

1. Разверните представление дерева Центра API, чтобы выбрать определение для зарегистрированной версии API.

2. Щелкните правой кнопкой мыши определение и выберите "Открыть документацию по API". Откроется новая вкладка с пользовательским интерфейсом Swagger для определения API.

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

• Центр API Azure — основные понятия
• Создание и регистрация API с помощью расширения Центра API Azure для Visual Studio Code
• Обнаружение и использование API с расширением Центра API Azure для Visual Studio Code
• Управление API с помощью расширения Центра API Azure для Visual Studio Code
• Включение и просмотр портала Центра API в Visual Studio Code
• Обзор GitHub Copilot для Azure