Создание и регистрация API с помощью расширения Центра API Azure для Visual Studio Code
Разработчики разработчиков API в вашей организации могут создавать и регистрировать API в инвентаризации центра API с помощью расширения Центра API Azure для Visual Studio Code. Разработчики API могут:
- Добавьте существующий API в центр API в качестве однократной операции или интегрируйте конвейер разработки для регистрации API в рамках рабочего процесса CI/CD.
- Используйте GitHub Copilot для создания новых спецификаций OpenAPI из кода API.
Разработчики-потребители API также могут воспользоваться функциями расширения для обнаружения и использования API в центре API и обеспечения управления API.
Необходимые компоненты
Один или несколько центров API в подписке Azure.
- В настоящее время необходимо назначить роль участника службы Центра API Azure или более высокие разрешения в центре API для управления API с расширением.
Для указанных сценариев требуются следующие расширения Visual Studio Code:
- GitHub Actions — регистрация API с помощью конвейера CI/CD с помощью GitHub Actions
- Azure Pipelines — регистрация API с помощью конвейера CI/CD с помощью Azure Pipelines
- GitHub Copilot — создание файлов спецификаций OpenAPI из кода API
Настройка расширения
Установите расширение Центра API Azure для Visual Studio Code из Visual Studio Code Marketplace. Установите другие расширения, перечисленные в предварительных требованиях.
Примечание.
Где отмечалось, некоторые функции доступны только в предварительной версии расширения Центра API Azure. При установке расширения из Visual Studio Code Marketplace можно установить версию выпуска или предварительную версию. Переключение между двумя версиями в любое время с помощью контекстного меню "Управление расширением" в представлении расширений.
В Visual Studio Code в строке действий слева выберите центр API.
Если вы не вошли в учетную запись Azure, выберите вход в Azure... и следуйте инструкциям по входу. Выберите подписку Azure с центром API (или центрами API), из которой вы хотите просмотреть API. Вы также можете отфильтровать определенные подписки, если у вас есть много для просмотра.
Регистрация API — пошаговые шаги
Следующие шаги регистрируют API в центре API в качестве одноразовой операции.
- Используйте сочетание клавиш CTRL+SHIFT+P, чтобы открыть палитру команд. Введите Центр API Azure: зарегистрируйте API и нажмите клавишу ВВОД.
- Выберите Вручную.
- Выберите центр API, чтобы зарегистрировать API с помощью.
- Ответы с информацией, включая название 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 продолжает развиваться с течением времени.
- Используйте сочетание клавиш CTRL+SHIFT+P, чтобы открыть палитру команд. Введите Центр API Azure: зарегистрируйте API и нажмите клавишу ВВОД.
- Выберите CI/CD.
- Выберите GitHub или Azure DevOps в зависимости от предпочтительного механизма управления версиями. Для расширения Центра API Azure необходимо открыть рабочую область Visual Studio Code, чтобы добавить конвейер в рабочую область. После добавления файла выполните действия, описанные в файле конвейера CI/CD, чтобы настроить необходимые переменные среды и удостоверение. При отправке в систему управления версиями API регистрируется в центре API.
Дополнительные сведения о настройке рабочего процесса GitHub Actions для регистрации API в центре API.
Создание спецификации OpenAPI из кода API
Используйте возможности GitHub Copilot с расширением Центра API Azure для Visual Studio Code, чтобы создать файл спецификации OpenAPI из кода API. Щелкните правой кнопкой мыши код API, выберите Copilot из параметров и выберите "Создать документацию ПО API". GitHub Copilot создает файл спецификации OpenAPI.
Примечание.
Эта функция доступна в предварительной версии расширения Центра API.
Создав файл спецификации OpenAPI и проверив точность, вы можете зарегистрировать API в центре API с помощью центра API Azure: зарегистрировать команду API .
Совет
Разработчики API также могут создавать новые спецификации OpenAPI с помощью запросов естественного языка с подключаемым модулем Центра API для GitHub Copilot для Azure. Подробнее.