Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управления API
В этой статье представлен обзор распространенных сценариев и ключевых компонентов службы управления Azure API Management. Служба управления API Azure является гибридной мультиоблачной платформой управления для интерфейсов API во всех средах. В качестве платформы как услуги (PaaS) API Management поддерживает полный жизненный цикл API.
Совет
Если вы уже знакомы со службой API Management и готовы начать, ознакомьтесь со следующими ресурсами:
Сценарии
API позволяют использовать цифровые возможности, упрощают интеграцию приложений, ложатся в основу новых цифровых продуктов, а также делают данные и службы доступными для повторного использования и универсального доступа. С распространением и повышением зависимости от API организации должны управлять ими в качестве ресурсов первого класса на протяжении всего жизненного цикла.
Azure Управление API помогает организациям выполнять следующие задачи:
- Предоставление комплексной платформы API для различных заинтересованных лиц и команд для создания API и управления ими
- Скрытие разнообразия и сложности архитектуры серверной части от пользователей API
- Безопасное предоставление служб, размещенных в Azure и за ее пределами, в качестве API
- Защита, ускорение работы и наблюдение за API
- Включение возможности обнаружения и использования API внутренними и внешними пользователями
Распространенные сценарии включают в себя:
- Разблокировка устаревших ресурсов — API используются для отделения и модернизации устаревших серверных частей и предоставления доступа к ним из новых облачных служб и современных приложений. API позволяют внедрять инновации без риска, лишних затрат и задержек, связанных с миграцией.
- Интеграция приложений, ориентированных на API — API представляют собой простые в использовании, основанные на стандартах и самостоятельно описываемые механизмы для предоставления и доступа к данным, приложениям и процессам. Они упрощают и сокращают затраты на интеграцию приложений.
- Многоканальные взаимодействия с пользователями — API часто используются для предоставления пользователям таких возможностей, как веб-приложения, мобильные приложения, переносимые приложения или Интернет вещей. Повторное использование API для ускорения разработки и рентабельности инвестиций.
- Интеграция B2B — API, предоставляемые партнерам и клиентам, снижают барьер для интеграции бизнес-процессов и обмена данными между бизнес-сущностями. API позволяют устранить издержки, присущие интеграции "точка — точка". Особенно при включении возможности самообслуживания для обнаружения и подключения, API являются основными инструментами для масштабирования интеграции B2B.
Совет
Посетите aka.ms/apimlove для ознакомления с библиотекой полезных ресурсов, включая видео, блоги и истории клиентов об использовании службы Azure API Management.
Компоненты службы управления API
Azure Управление API состоит из API-шлюза, контрольного уровня и портала разработчика, с функционалом, предназначенным для разных аудиторий в экосистеме API. Эти компоненты размещаются в Azure и полностью управляются по умолчанию. Служба управления API доступна на различных уровнях, отличающихся емкостью и функциями.
Шлюз API
Все запросы от клиентских приложений сначала достигают шлюза API (также называемого плоскостем данных или средой выполнения), который затем перенаправляет их в соответствующие серверные службы. Шлюз API выступает в качестве фасада серверных служб, позволяя поставщикам API отделять реализации API и развивать архитектуру серверной части, не влияя на объекты-получатели API. Шлюз обеспечивает согласованную конфигурацию маршрутизации, безопасности, регулирования, кэширования и наблюдаемости.
В частности, шлюз:
- выступает в качестве фасада для бэкэндов, принимая вызовы API и перенаправляя их в соответствующие бэкэнды.
- проверяет ключи API и другие учетные данные, такие как токены JWT и сертификаты, представленные запросами;
- принудительно применяет квоты использования и ограничения скорости;
- при необходимости преобразует запросы и ответы, указанные в инструкциях политики;
- если настроить, кэширует ответы, чтобы повысить задержку ответа и свести к минимуму нагрузку на серверные службы;
- создает журналы, метрики и трассировки для мониторинга, создания отчетов и устранения неполадок.
Самостоятельно размещенный шлюз
С помощью локального шлюза поставщик API может развернуть шлюз API в тех же средах, где они размещают СВОИ API, для оптимизации трафика API и обеспечения соответствия локальным правилам и рекомендациям. Локальный шлюз позволяет организациям с гибридной ИТ-инфраструктурой управлять API, размещенными в локальной среде и в облаках из одной службы Управление API в Azure.
Локальный шлюз упаковывается в виде контейнера Docker на базе Linux и обычно развертывается в Kubernetes, включая Службу Azure Kubernetes и Kubernetes с поддержкой Azure Arc.
Подробнее:
Управляющий уровень
Поставщики API взаимодействуют со службой через плоскость управления (также называемую плоскость управления), которая обеспечивает полный доступ к возможностям службы Управление API.
Клиенты взаимодействуют с плоскости управления с помощью средств Azure, включая портал Azure, Azure PowerShell, Azure CLI, расширение Visual Studio Code, REST API или клиентские пакеты SDK на нескольких популярных языках программирования.
Используйте плоскость управления для выполнения следующих действий:
- Подготовка и настройка параметров службы управления API
- Определение или импорт схем API из широкого спектра источников, включая определения OpenAPI, WSDL и OData, вычислительные сервисы Azure и WebSocket, GraphQL и серверные части gRPC
- Упаковка API в продукты
- Настройка политик, например, квот или преобразований, в интерфейсах API
- Получение дополнительных сведений на основе аналитики
- Управление пользователями, такими как разработчики приложений
Портал разработчика
Портал разработчика с открытым кодом — это автоматически создаваемый и полностью настраиваемый веб-сайт с документацией по API.
Поставщики API могут настраивать вид и дизайн портала разработчика, добавляя произвольное содержимое, изменяя стили и реализуя корпоративный дизайн. Можно еще более расширить портал разработчиков с помощью самостоятельного хостинга.
Потребители API, такие как разработчики приложений, получают доступ к порталу разработчиков с открытым исходным кодом, чтобы находить API, интегрировать их для использования и узнавать, как применять их в приложениях. (API также можно экспортировать в Power Platform для обнаружения и использования разработчиками-любителями.)
С помощью портала разработчика потребители API могут:
- читать документацию по API;
- вызывать API через интерактивную консоль;
- создавать учетную запись и оформлять подписку для получения ключей API;
- получать доступ к аналитике по использованию;
- Загрузите описания API
- Управление ключами API
Управление федеративными API с рабочими областями
Для организаций, которые хотят расширить возможности децентрализованных команд для разработки и управления собственными API с преимуществами централизованного управления API и обнаружения, Управление API предлагает поддержку федеративной модели управления API с рабочими областями.
В управлении API рабочие области обеспечивают новый уровень автономии для команд API организации, позволяя им быстрее, надежнее, безопаснее и продуктивнее создавать, управлять и публиковать API в службе управления API. Обеспечивая изолированный административный доступ и среду выполнения API, рабочие пространства предоставляют возможность командам API, позволяя команде платформы API сохранять контроль. Это включает централизованный мониторинг, применение политик и соответствия API, а также публикацию API для обнаружения с помощью единого портала разработчика.
Дополнительные сведения:
Уровни управления API
Управление API предлагается в различных ценовых категориях для удовлетворения потребностей разных клиентов. Каждый уровень предлагает различные сочетания функций, производительности, ограничений емкости, масштабируемости, обслуживания и ценообразования для разных сценариев. Уровни группируются следующим образом:
- Классический — изначальное предложение по управлению API, включая уровни "Разработчик", "Базовый", "Стандартный" и "Премиум". Уровень "Премиум" предназначен для предприятий, требующих доступа к частным серверным службам, расширенным функциям безопасности, развертываниям в нескольких регионах, зонам доступности и высокой масштабируемости. "Уровень разработчика — это экономичная опция для использования в непроизводственных целях, а уровни «Базовый», «Стандартный» и «Премиум» готовы для производственного использования."
- Версия 2 . Новый набор уровней, которые предлагают быструю подготовку и масштабирование, включая Базовую версию 2 для разработки и тестирования, а также стандартную версию 2 и Премиум версии 2 для рабочих нагрузок. Стандартная версия 2 и Premium версии 2 поддерживает интеграцию виртуальной сети для упрощенного подключения к изолированным от сети серверным службам. Премиум версии 2 также поддерживает внедрение виртуальной сети для полной изоляции сетевого трафика к шлюзу и из нее.
- Потребление — бессерверный шлюз для управления API, масштабируемый в зависимости от спроса и оплачиваемый за каждое выполнение. Он предназначен для приложений с бессерверными вычислениями, архитектурами на основе микрослужб и шаблонами трафика переменных.
Дополнительные сведения:
- Сравнение возможностей категорий управления API Azure
- Уровни служб версии 2
- Расценки на службу управления API
Интеграция со службами Azure
Служба API Management интегрируется со многими дополнительными службами Azure, включая следующие:
- Центр API Azure для создания полной инвентаризации API в организации независимо от их типа, этапа жизненного цикла или расположения развертывания для обнаружения, повторного использования и управления API
- Copilot в Azure для написания политик управления API или для объяснения уже настроенных политик
- Azure Key Vault для безопасного хранения и управления сертификатами клиента и секретами
- Azure Monitor для ведения журнала, создания отчетов и оповещений об операциях управления, событиях систем и запросах API
- Application Insights для получения динамических метрик, сквозной трассировки и устранения неполадок
- Виртуальные сети, частные конечные точки, Шлюз приложений и Azure Front Door для защиты на уровне сети
- Azure Defender для API и Azure DDoS Protection для защиты среды выполнения от вредоносных атак
- Идентификатор Microsoft Entra для проверки подлинности разработчика и авторизации запроса
- Центры событий для потоковой передачи событий
- Azure Redis для кэширования ответов с помощью Azure Cache для Redis или Azure Managed Redis
- Несколько вычислительных служб Azure, часто используемых для создания и размещения API в Azure, включая Функции, Logic Apps, Веб-приложения, Service Fabric и другие, включая службу Azure OpenAI.
- Предложения базы данных Azure, включая Azure Cosmos DB, включение прямых операций CRUD (создание, чтение, обновление, удаление) без необходимости использования промежуточных вычислительных ресурсов.
Дополнительные сведения:
- Базовая корпоративная интеграция
- Акселератор посадочной зоны
- Возможности шлюза искусственного интеллекта в службе "Управление API"
- Синхронизация API с Центром API из управления API
Основные понятия
Программные интерфейсы
API являются основой экземпляра службы управления API. Каждый API включает набор операций, доступных разработчикам приложений. Каждый API содержит ссылку на серверную службу, которая реализует API, и его операции сопоставляются с операциями этой серверной службы.
Операции в API Management высоко настраиваемые, включая управление сопоставлением URL-адресов, параметров запроса и пути, содержимого запроса и ответа и кэшированием ответов операций.
Дополнительные сведения:
Продукты
Продукты — это способ предоставления API потребителям API, таким как разработчики приложений. Продукты в API Management имеют один или несколько API и могут быть открытыми или защищенными. Защищенные продукты требуют ключа подписки, а открытые продукты можно использовать свободно.
Когда продукт готов к использованию потребителями, его можно опубликовать. После публикации его можно просматривать или подписываться пользователями на портал разработчика. Утверждение подписки настраивается на уровне продукта и может требовать утверждения администратором или быть автоматическим.
Дополнительные сведения:
Пользователи и группы
Пользователи (потребители API) могут быть созданы или приглашены администраторами служб или могут зарегистрироваться на портале разработчика. Каждый пользователь является членом одной или нескольких групп и может подписаться на продукты, предоставляющие видимость для этих групп.
API Management включает следующие встроенные группы:
Разработчики — пользователи портала разработчиков с проверкой подлинности, создающие приложения с помощью API. Разработчикам предоставляется доступ к порталу разработчика, и они могут создавать приложения, вызывающие операции этого API.
Гости — пользователи портала разработчиков, не прошедшие проверку подлинности, например, возможные клиенты, посетившие портал разработчиков. Им может быть предоставлен доступ только для чтения, позволяющий просматривать API, но не вызывать их.
Владельцы служб управления API также могут создавать пользовательские группы или использовать внешние группы в связанном арендаторе Microsoft Entra, чтобы предоставить пользователям видимость и доступ к продуктам API. Например, можно создать пользовательскую группу для разработчиков в партнерской организации для доступа к определенному подмножеству API в продукте. Пользователь может принадлежать к нескольким группам.
Дополнительные сведения:
Рабочие пространства
Рабочие области поддерживают федеративную модель управления API, позволяя децентрализованным командам разработчиков API управлять и превращать свои API в продукты, в то время как центральная команда платформы API поддерживает инфраструктуру управления API. Каждая рабочая область содержит API, продукты, подписки и связанные сущности, доступные только участникам совместной работы рабочей области. Доступ контролируется с помощью управления доступом на основе ролей Azure (RBAC). Каждая рабочая область связана с одним или несколькими шлюзами рабочих областей, которые направляют трафик API в внутренние службы.
Дополнительные сведения:
Политики
С помощью политик поставщик API может изменить поведение API через конфигурацию. Политики представляют собой набор правил, которые выполняются последовательно для запроса или ответа API. К часто используемым утверждениям относятся преобразование формата из XML в JSON и ограничение частоты вызовов, чтобы ограничить количество входящих вызовов от разработчика. Полный список приведен в разделе Политики управления API.
Выражения политики можно использовать в качестве значений атрибутов или текстовых значений во многих политиках Управление API. Некоторые политики (в том числе Поток управления и Задание переменной) основаны на выражениях политики.
Политики могут применяться в разных областях в зависимости от потребностей: глобальные (все API), рабочая область, продукт, конкретный API или операция API.
Дополнительные сведения:
Следующие шаги
Изучите следующее краткое руководство и приступите к использованию службы управления API Azure: