Что такое служба управления Azure API?

6 мин

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

Что такое управление жизненным циклом API?

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

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

Определение службы "Управление API" Azure

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

Шлюз
Интерфейс администрирования
Портал разработчика

Внимание

В службе "Управление API" Azure не размещаются реальные API-интерфейсы — они остаются там, где были изначально развернуты. Вместо этого служба "Управление API" Azure выступает в качестве передней точки входа для API-интерфейсов. Таким образом, Azure Управление API отделяет API, позволяя задавать политики API и другие параметры управления в Azure, оставляя развернутые серверные API неотключаемыми.

Шлюз

Шлюз службы "Управление API" Azure — это конечная точка Azure, которая принимает все вызовы от всех ваших API. Шлюз выполняет следующие функции.

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

Интерфейс администрирования

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

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

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

Портал разработчика Azure Управление API — это полностью настраиваемый веб-сайт, который позволяет разработчикам взаимодействовать с API через:

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

Уровни службы "Управление API" Azure

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

Критерии	Потребление	Разработчик	Базовая	Стандартные	Премиум
Целевая аудитория	Упрощенное использование	Оценка, тестирование и другое непроизводство использования	Начальный уровень для рабочих сред	Использование в рабочей среде среднего объема	Использование в рабочей среде с большим объемом или на предприятии
Cache	Только внешний	10 мегабайт (МБ)	50 МБ	1 гигабайт (ГБ)	5 ГБ
Соглашение об уровне обслуживания (SLA)	99,95 %	нет	99,95 %	99,95 %	99,99 %
Developer portal	No	Да	Да	Да	Да
Встроенная аналитика	No	Да	Да	Да	Да
Пропускная способность (предполагаемое количество запросов в секунду)	Н/П	500	1,000	2500	4000

Примечание.

Цены на уровень потребления выставляются по каждому вызову API, где первые миллион вызовов бесплатны, а остальные выставляются по фиксированной ставке за 10 000 вызовов. Цены на все остальные уровни в час.

Применение политик к запросам и ответам API

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

Служба "Управление API" Azure решает проблему с политиками API, позволяя устанавливать политики для всех API в одном месте — интерфейсе администрирования. С помощью Azure Управление API можно задать политики во многих категориях. Частичный список включает в себя:

Ограничение доступа. Эти политики определяют, разрешен ли запрос API через шлюз. Например, применение ограничений скорости и квот использования, IP-адресов вызывающего обработчика фильтров и проверка допустимого веб-токена JSON (JWT).
Проверка подлинности. Проверка подлинности вызовов API, например с помощью базовой проверки подлинности, сертификата клиента или управляемого удостоверения.
Кэширование. Повышение производительности API путем хранения и получения ответов в кэше.
Проверка. Проверьте вызовы API, сравнивая определенные параметры с спецификацией API. Например, проверьте текст запроса или ответа, параметры заголовка запроса и заголовки ответа.

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