Создание и регистрация API с помощью расширения Центра API Azure для Visual Studio Code

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

• Добавьте существующий API в центр API в качестве однократной операции или интегрируйте конвейер разработки для регистрации API в рамках рабочего процесса CI/CD.
• Используйте GitHub Copilot для создания новых спецификаций OpenAPI из кода API.

Разработчики-потребители API также могут воспользоваться функциями расширения для обнаружения и использования API в центре API и обеспечения управления API.

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

• Visual Studio Code

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

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

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

Для указанных сценариев требуются следующие расширения Visual Studio Code:

• GitHub Actions для регистрации API в конвейере CI/CD с использованием GitHub Actions
• Azure Pipelines для регистрации API с помощью конвейера CI/CD с помощью Azure Pipelines
• GitHub Copilot для создания файлов спецификаций OpenAPI из кода API

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

Настройте расширение, выполнив следующие действия.

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

   Примечание.

   Нотация [PREVIEW] указывает функции, доступные только в предварительной версии расширения Центра API Azure. При установке расширения из Visual Studio Code Marketplace можно установить версию выпуска или предварительную версию (как доступно). Чтобы переключаться между установленными версиями, нажмите кнопку "Управление расширением" (значок шестеренки) в представлении расширений в Visual Studio Code.

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

   

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

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

Регистрация API вручную

Следующие шаги регистрируют API в центре API в качестве одноразовой операции.

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

API добавляется в каталог центра API.

Регистрация API с помощью конвейера CI/CD

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

1. Используйте сочетание клавиш CTRL+SHIFT+P, чтобы открыть палитру команд. Введите Центр API Azure: зарегистрируйте API и нажмите клавишу ВВОД.
2. Выберите CI/CD.
3. Выберите GitHub или Azure DevOps в зависимости от предпочтительного механизма управления версиями. Для того чтобы расширение Центра API Azure смогло добавить пайплайн в вашу рабочую область, необходимо, чтобы была открыта рабочая область Visual Studio Code. После добавления файла выполните действия, описанные в файле конвейера CI/CD, чтобы настроить необходимые переменные среды и идентификацию. При отправке в систему управления исходным кодом API регистрируется в центре API.

Дополнительные сведения о настройке рабочего процесса GitHub Actions см. в разделе "Регистрация API" в центре API с помощью GitHub Actions.

Создание спецификации OpenAPI из кода API

Используйте возможности GitHub Copilot с расширением Центра API Azure для Visual Studio Code, чтобы создать файл спецификации OpenAPI из кода API. Щелкните правой кнопкой мыши код API, выберите Copilot из параметров и выберите "Создать документацию ПО API". GitHub Copilot создает файл спецификации OpenAPI.

Вы также можете создать спецификацию OpenAPI из всех файлов в текущем проекте. Используйте команду Центр API Azure: создайте спецификацию OpenAPI из всего проекта из палитры команд.

Создав файл спецификации OpenAPI и проверив его точность, вы можете зарегистрировать API с помощью команды Azure API Center: Register API в вашем центре API.

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

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