API – незаменимый современный способ взаимодействия программ. Конвейеры непрерывной интеграции (CI) и непрерывного развертывания (CD) стали важным аспектом его создания. Их использование дает возможность быстрой и простой разработки API без ошибок, появляющихся при работе вручную.
Основные проблемы
Сегодня организации в работе используют несколько механизмов (например, разработка, тестирование, производство), при этом применяются отдельные экземпляры API Management для каждой среды. Некоторые из них совместно используются несколькими командами разработчиков, которые отвечают за разные API.
Основные вопросы, которыми задаются пользователи:
- Как автоматизировать развертывание API в API Management?
- Как перенести конфигурации из одной среды в другую?
- Как избежать несогласованности между различными командами и вмешательства в работу разработчиков, которые используют один и тот же экземпляр API Management?
Ниже описаны методы, помогающие решить эти проблемы.
CI/CD с управлением API
Допустим, есть две среды развертывания: разработка и производство. У каждой ‒ свой собственный экземпляр управления API, с которым работает отдельная команда издателей. Разработчики API имеют доступ только к экземпляру разработки.
Ключевым моментом в этом случае становится сохранение всех конфигураций в шаблонах Azure Resource Manager. Они должны храниться в системе контроля версий. Мы будем использовать Git в качестве примера. Как показано на рисунке, существует репозиторий Publisher, который содержит все конфигурации экземпляра Production API Management:
- шаблон службы – включает все конфигурации уровня обслуживания (например, установленные цены и настраиваемые домены);
- общий шаблон – содержит общие ресурсы в экземпляре API Management (например, группы и продукты);
- API-шаблон – состоит из конфигураций API и их подресурсов;
- мастер-шаблон, связывающий все вышеуказанные элементы.
Как только разработчики закончат создание и тестирование и сгенерируют шаблон API, они отправят запрос на извлечение в репозиторий Publisher. Издатели могут проверить его и убедиться, что изменения безопасны. Большинство проверок станут автоматизированными как часть конвейера CI/CD. Когда изменения будут одобрены, издатели API развернут их в производственном экземпляре. Развертывание также можно легко автоматизировать.
При таком подходе развертывание изменений API в экземплярах API Management можно упростить, а также появляется возможность без труда внести изменения из одной среды в другую. Поскольку разные группы разработчиков будут работать над разными наборами шаблонов, снизится вероятность вмешательства команд в работу.