Предстоящее | API7 DevPortal - Повышение эффективности управления API на новый уровень

В современном мире компьютеров люди привыкли использовать API как средство обмена информацией между программными приложениями. Будь то проверка прогноза погоды на телефоне, просмотр моментов в WeChat или взаимодействие с ChatGPT, все эти действия становятся возможными благодаря API. API — это набор соглашений о взаимодействии, которые определяют, как вы (или ваше программное обеспечение) можете взаимодействовать с целевым программным сервисом.

Полный жизненный цикл управления API

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

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

Планирование и проектирование

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

Обычно планирование и проектирование API вращаются вокруг документации. Например, при проектировании RESTful API документация API должна включать следующую информацию:

• Описание функции API
• Соответствующий URL для API
• Метод HTTP-запроса
• Описание (и ограничения) параметров запроса, тела запроса и заголовков запроса
• Возможные коды состояния ответа и описание тела ответа

Было проведено много исследований о том, как написать четкую и всеобъемлющую документацию API, и в настоящее время популярным подходом является использование спецификации OpenAPI V3.

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

Реализация

После завершения проектирования API инженеры могут приступить к его разработке. Они могут выбрать технологический стек, в котором они хорошо разбираются или который требует организация, для реализации API. Во время разработки инженеры также могут тестировать API, добавляя сквозные тесты или запрашивая тестирование у команды QA. После завершения реализации инженеры могут подготовиться к развертыванию 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 с действительными учетными данными API.
• Наконец, чтобы снизить затраты на коммуникацию и сотрудничество, использование API должно быть максимально самостоятельным.

Для решения этих проблем и оптимизации использования API была введена концепция портала разработчика.

Порталы разработчика

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

Портал разработчика обычно состоит из двух сайтов: сайта управления и сайта разработчика. Сайт управления используется производителями API (далее именуемыми администраторами), а сайт разработчика используется потребителями API (далее именуемыми разработчиками).

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

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

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

По мере развития экосистемы API концепция монетизации API получает все больше внимания. Портал разработчика стал ценным инструментом для монетизации API. Администраторы могут создавать несколько планов подписки для API и взимать разные платы в зависимости от различных квот или количества вызовов API.

Предстоящий API7 DevPortal

API7.ai стремится предоставлять непревзойденные услуги по управлению API нашим пользователям. Мы рады представить наше новое предложение, API7 DevPortal, комплексный продукт портала разработчика, который бесшовно интегрируется с нашим корпоративным решением API-шлюза, API7 Enterprise, построенным на Apache APISIX.

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

Кроме того, мы понимаем важность оптимизации рабочих процессов для повышения производительности и увеличения доходов. Поэтому API7 DevPortal будет проходить две значительные итерации в будущем.

• Во-первых, мы интегрируемся с рабочими процессами утверждения наших клиентов. Некоторые из наших клиентов имеют единую платформу утверждения для управления различными операциями утверждения. Мы стремимся позволить клиентам использовать API7 DevPortal, не изменяя свои существующие привычки утверждения.

• Во-вторых, мы поддержим монетизацию API, чтобы помочь нашим клиентам предоставлять услуги подписки на разных уровнях разработчикам и поддерживать сбор платы. Мы скоро запустим API7 DevPortal на рынке.

Если вас заинтересовал этот продукт, пожалуйста, нажмите здесь, чтобы связаться с нами.

Заключение

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