API7 Enterprise v3.3.0 поддерживает API Portal

Обзор портала для разработчиков

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

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

2. Повышение эффективности разработки и эксплуатации: Функции самообслуживания, такие как поиск документации, тестирование и отладка, сокращают повторяющиеся коммуникации и обслуживание документации, тем самым повышая общую эффективность.

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

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

Провайдерский портал API7 и портал для разработчиков

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

Провайдерский портал API7

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

• Целевая аудитория: Поставщики API и администраторы
• Основные функции:
  • Публикация и управление продуктами API.
  • Управление разработчиками.
  • Настройка политик доступа к порталу для разработчиков, таких как анонимный просмотр API и методы входа.
  • Визуализация статистики доступа к API, выполнение аналитики и отслеживание логов.

Портал для разработчиков API7

Портал для разработчиков API7 предоставляет единую точку входа для разработчиков или партнеров, позволяя им быстро понять, получить доступ и использовать сервисы API.

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

Как использовать портал API7

Доступ к провайдерскому порталу API7

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

Создание и публикация продуктов API

Продукты API являются основным ресурсом в Провайдерском портале API7, представляя собой группу связанных API. Разработчики обычно подписываются на API на уровне продукта. Существует два метода создания продуктов API.

1. На основе опубликованных сервисов в API7 Gateway

• Выберите существующие опубликованные сервисы в API7 Gateway и сгруппируйте их в продукт API.
• В рамках продукта API каждый маршрут соответствующего сервиса рассматривается как независимый API.

2. Импорт файлов OpenAPI

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

Пример: Добавление продукта API из API7 Gateway

Чтобы добавить продукт API, нажмите кнопку "Добавить продукт API" и выберите пункт меню "Из API7 Gateway", чтобы перейти к форме создания продукта API.

В форме необходимо заполнить следующую информацию:

1. Основные данные: Включает имя, описание, метки, логотип и т.д.

2. Тип аутентификации: Укажите, требуется ли одобрение.

3. Видимость: Установите область видимости продукта API.

4. Связанные сервисы шлюза: Выберите опубликованный сервис шлюза, который соответствует следующим двум условиям:

   • Настроено имя хоста.
   • Загружен документ OpenAPI.

Добавление нового продукта API

Если ни один сервис не соответствует требованиям, вы можете выполнить следующие шаги настройки.

1. Загрузка документа OpenAPI и настройка имени хоста для существующих сервисов

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

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

Затем в разделе Маршруты на странице деталей сервиса или шаблона настройте hosts в модуле URL запроса. По умолчанию hosts установлен на "*", что означает, что сервис обрабатывает запросы с любого имени хоста.

Для связывания сервиса с продуктом API необходимо указать точный хост. Это требование гарантирует, что разработчики могут получить доступ к API, используя полный формат пути: хост + префикс пути + API.

2. Создание нового сервиса для связывания с продуктом API

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

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

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

Публикация продукта API

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

Доступ к порталу для разработчиков API7

Вы можете получить доступ к порталу для разработчиков API7 двумя способами:

1. Посетите URL портала для разработчиков.
2. Нажмите кнопку Портал для разработчиков в левом меню панели управления портала API7.

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

Создание разработчика

Существует два способа создания учетной записи разработчика:

• Самостоятельная регистрация: Разработчики регистрируются самостоятельно на странице входа.
• Приглашение администратора: Администраторы создают учетные записи через панель управления портала API7.

Самостоятельная регистрация

Нажмите кнопку Зарегистрироваться на странице входа и заполните форму, указав имя пользователя и пароль.

Регистрация, инициированная администратором

В панели управления портала API7 перейдите в раздел Разработчики и нажмите Пригласить разработчика. Заполните форму, указав имя пользователя и одноразовый пароль, и при необходимости укажите отображаемое имя для идентификации.

После добавления разработчика поделитесь именем пользователя и паролем с пользователем. При первом входе в систему они должны сбросить пароль.

Просмотр продуктов API

После входа в систему разработчики могут нажать API Hub, чтобы просмотреть все опубликованные продукты API.

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

Отладка продуктов API

Кроме того, разработчики могут тестировать API напрямую, нажав кнопку Тестовый запрос.

После нажатия Тестовый запрос вы увидите панель онлайн-тестирования.

• URL запроса автоматически генерируется на основе конфигурации сервиса, связанного с продуктом API.
• Метод аутентификации по умолчанию установлен на Key Auth и автоматически заполняет API Key для текущей учетной записи разработчика.

Разработчикам нужно только дополнить необходимые параметры запроса в соответствии с определением интерфейса API, чтобы продолжить отладку.

Подписка на продукты API

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

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

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

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

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

Решение об одобрении напрямую влияет на права доступа разработчика к API:

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

Заключение

API7 Enterprise объединяет платформу API-шлюза с порталом для разработчиков, создавая эффективное решение для управления API как для поставщиков API, так и для разработчиков.

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