Упростите управление жизненным циклом продуктов API

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

Управление API с полным жизненным циклом (APIM) охватывает весь жизненный цикл API, начиная с этапа планирования и заканчивая прекращением поддержки API. Многие этапы жизненного цикла интегрированы с шлюзом API (основным компонентом системы управления API). В этом посте вы пройдете через 3 ключевых этапа жизненного цикла продукта API: создание, управление и использование, а также узнаете, почему API Gateway важен в каждом жизненном цикле. этап.

10 типичных этапов жизненного цикла API

Жизненный цикл API — это модель, которая может помочь вам наметить прогресс вашего API и адаптировать управление по мере его развития. В целом управление жизненным циклом API можно разбить на несколько этапов:

Создание — спроектируйте и создайте свой API.
Тестирование. Проверка функциональности, производительности и ожидаемой безопасности.
Публикация — представьте свои API разработчикам.
Безопасность. Снижение рисков и опасений, связанных с безопасностью.
Управление. Поддерживайте API и управляйте ими, чтобы обеспечить их функциональность, актуальность и соответствие бизнес-требованиям.
Подключение — позволяет разработчикам быстро научиться использовать открытые API. Например, предложите документацию OpenAPI или AsyncAPI и предоставьте портал и песочницу.
Анализ — включение возможности наблюдения и анализа данных мониторинга для понимания использования и выявления проблем.
Продвижение – рекламируйте API разработчикам, например размещайте их объявления на рынке API.
Монетизация — включение взимания платы и сбора доходов за использование API. Мы рассмотрим этот аспект управления жизненным циклом API как отдельный этап в следующем разделе.
Прекращение поддержки. Поддержите прекращение поддержки и удаление API, что происходит по разным причинам, в том числе из-за смены бизнес-приоритетов, технологических изменений и проблем с безопасностью.

Учтите, что существует четыре общепринятых этапа жизненного цикла продукта, такие как развитие, рост, зрелость и упадок, через которые проходят все продукты с точки зрения рыночного спроса. Теперь, если мы возьмем концепцию жизненного цикла продукта и применим ее к API, чтобы получить жизненный цикл продукта API, состоящий из 5 этапов: создать, опубликовать, реализовать, поддерживать и удалить. Вы можете дополнительно сузить этот список до 3 основных этапов: создание, управление и потребление соответственно, интегрировав шлюз API для управления полным жизненным циклом продукта API.

На приведенной ниже диаграмме показано, как управление жизненным циклом API интегрируется со шлюзом API и серверными службами:

Прежде чем мы рассмотрим каждый из этих трех этапов, давайте сначала разберемся, какие проблемы может решить API Gateway.

Шлюз API решает ключевые проблемы

Когда вы имеете дело с API, управлением трафиком и выбором связанных технологий, вам необходимо сбалансировать как краткосрочную реализацию, так и долгосрочную ремонтопригодность. Существует множество сквозных проблем, связанных с API, включая обслуживаемость, расширяемость, безопасность, наблюдаемость, управление жизненным циклом продукта и монетизацию. Шлюз API может помочь со всем этим!

Вот обзор основных проблем, которые может решить шлюз API, например:

Уменьшение связи за счет использования адаптера/фасада между интерфейсами и серверами.
Упрощение потребления за счет агрегирования/перевода бэкэнд-сервисов.
Защита API от чрезмерного использования и злоупотреблений с помощью обнаружения и устранения угроз.
Понимание того, как используются API (наблюдаемость).
Управление API как продуктами с управлением жизненным циклом API.
Монетизация API с помощью управления аккаунтом, выставления счетов и оплаты.

Этап создания API

Этап создания API — это первый этап процесса управления жизненным циклом продукта API, на котором вы проектируете, координируете, преобразуете, документируете и тестируете свой API. На этом этапе современные шлюзы API, такие как Apache APISIX, могут быть полезны для создания вашего API с нуля или импорта определений API из ряда источников, таких как структура OpenAPI YAML/JSON, для регистрации Route и Upstreams.

Возможно, вы захотите предоставить новый API, объединяющий информацию из других существующих API. Этого можно добиться с помощью возможности составления ответов шлюза API. Или вы соединяете внутреннюю и внешнюю системы через новый API, где они используют разные форматы для обмена данными с XML/SOAP на JSON REST и наоборот. У вас есть существующий REST API, но вы создаете новый GraphQL API. Например, Apache APISIX позволяет конвертировать GraphQL API в REST API.

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

Этап контроля API

На этапе контроля вы применяете политики безопасности, развертываете, управляете, отслеживаете и масштабируете свой API. После тестирования пришло время защитить ваш API, чтобы гарантировать, что только авторизованные пользователи и приложения могут получить доступ к API, а также предотвратить несанкционированный доступ или злоупотребления. Это может включать использование методов, таких как проверка ввода, OAuth или ключи API, и настройку элементов управления для управления доступом к API, таких как настройка ограничений использования или квот с помощью API Gateway. Кроме того, вы отслеживаете показатели, трассировки и журналы API, а затем оптимизируете производительность API на основе данных аналитики.

На этом же этапе вы можете использовать различные стратегии выпуска API с API Gateway для мгновенного развертывания API в целевой среде (разработка, тестирование, подготовка и производство) без усилий по настройке и без простоев. Вы интегрируете API с инструментами DevOps, чтобы эффективно сократить время развертывания, используя передовые методы непрерывной интеграции/непрерывной разработки (CI/CD).

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

Этап потребления API

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

Потребители API — это фактические пользователи API. С помощью решения для управления API вы можете зарегистрировать одного или нескольких потребителей API и настроить различные правила для разных потребителей (частных, партнерских или общедоступных API). пользователей).

На этом этапе вы можете использовать различные стратегии продвижения API, чтобы рекламировать API разработчикам и размещать их на рынке API. Кроме того, вы можете рассмотреть возможность включения взимания платы и сбора доходов за использование API для монетизации вашего API.

Краткое содержание

В целом управление жизненным циклом продукта API состоит из трех основных этапов: создание, контроль и использование. Этап создания API является критическим этапом в процессе управления жизненным циклом API, поскольку он закладывает основу для успеха API, когда вы проектируете и создаете свой API. Этап контроля API помогает обеспечить безопасность, производительность и доступность API для авторизованных пользователей и приложений. Фаза использования API представляет собой момент, когда разработчики и другие пользователи начинают извлекать пользу из API. Убедившись, что API хорошо задокументирован, прост в использовании и хорошо работает, организации могут стимулировать внедрение и максимизировать ценность своих инвестиций в API.

Шлюз API — это инструмент, который находится перед API и выступает в качестве точки входа для определенной группы сервисов. Он участвует в полном жизненном цикле управления API, который охватывает процесс создания, развертывания и управления вашими API. Некоторые преимущества использования шлюза API заключаются в предоставлении оптимального API для каждого потребителя, сокращении количества запросов и применении политик безопасности.

Связанные ресурсы

Сообщество

🙋 Присоединяйтесь к сообществу Apache APISIX
🐦 Следите за нами в Twitter
📝 Найдите нас в Slack
💁 Как внести свой вклад

Об авторе

Посетите мой личный блог: www.iambobur.com

Упростите управление жизненным циклом продуктов API