Сведения о службе "Управление API"

  • 3 мин

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

Компоненты службы управления API

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

  • Шлюз API – конечная точка, которая:

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

  • Плоскость управления — это административный интерфейс, в котором настроена программа API. Он используется для следующих задач:

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

  • Портал разработчика — это автоматически созданный полностью настраиваемый веб-сайт с документацией по API. С помощью портала разработчика разработчики могут:

    • читать документацию по API;
    • вызывать API через интерактивную консоль;
    • создавать учетную запись и оформлять подписку для получения ключей API;
    • получать доступ к аналитике по использованию;
    • скачивать определения API;
    • Управление ключами API

Товары

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

Группы

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

  • Администраторы управляют экземплярами службы API Management, созданием API, операциями и продуктами, которые используются разработчиками. Администраторы подписок Azure принадлежат к этой группе.
  • Разработчики — пользователи портала разработчиков с проверкой подлинности, создающие приложения с помощью API. Разработчикам предоставляется доступ к порталу разработчика, и они могут создавать приложения, вызывающие операции этого API.
  • Гости — пользователи портала разработчика, не прошедшие проверку подлинности. Им можно предоставить доступ только для чтения, например возможность просматривать API- интерфейсы, но не вызывать их.

Помимо этих системных групп администраторы могут создавать пользовательские группы или использовать внешние группы в связанных клиентах Microsoft Entra.

Разработчики

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

Политики

Политика — это коллекция правил, которые выполняются последовательно над запросом или ответом API. Часто используемые правила включают преобразование формата из XML в JSON и ограничение скорости вызовов, позволяющее ограничить число входящих вызовов от разработчика; доступны и другие политики.

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

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