Создание шлюза API

  • 5 мин

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

В примере с компанией-производителем обуви NorthWind Shoes розничным магазинам, закупающим у нее продукцию, требуется знать объем запасов, доступных для заказа. Кроме того, клиенты компании хотят знать точное время, в течение которого будет доставлен их заказ.

Здесь вы узнаете, как работает azure Управление API и как настроить шлюз API.

Служба управления API Azure

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

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

Зачем использовать службу управления API?

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

  • Документация по API. Благодаря проработанной документации по API вызывающие клиенты смогут легко интегрировать их со своими решениями. Управление API позволяет быстро предоставлять структуру API вызову клиентов с помощью современных стандартов, таких как OpenAPI. Вы можете использовать несколько версий своего API. Благодаря поддержке нескольких версий вы можете размещать промежуточные обновления своих приложений, поскольку использующие их приложения не будут обращаться к ним немедленно.
  • Ограничение частоты обращений. Если ваш API может получать доступ к большим объемам данных, рекомендуется ограничить частоту, с которой клиенты могут запрашивать данные. Ограничение частоты позволяет обеспечить оптимальное время отклика для каждого клиента. Служба управления API поддерживает ограничение частоты как на общем уровне, так и для отдельных клиентов.
  • Наблюдение за работоспособностью. Удаленные клиенты используют API, поэтому может быть трудно определить потенциальные проблемы или ошибки. С помощью службы управления API вы можете просматривать ответы с сообщениями об ошибках и файлы журналов, а также выполнять фильтрацию по типу ответа.
  • Современные форматы, такие как JSON. На протяжении многих лет API использовали множество различных форматов обмена данными, включая XML, CSV и многие другие. Благодаря службе управления API вы сможете предоставлять такие форматы с использованием современных моделей данных, таких как JSON.
  • Подключения к любому интерфейсу API. Во многих компаниях API находятся в разных странах или регионах и используют разные форматы. С помощью службы управления API вы сможете объединить все разрозненные API в одном современном интерфейсе.
  • Аналитика. В процессе разработки API важно знать, как часто и из систем каких типов выполняются вызовы к вашим API. С помощью службы управления API вы сможете визуализировать эти данные на портале Azure.
  • Безопасность. При работе с системными данными первостепенное значение имеет безопасность. Несанкционированный доступ к данным может стать причиной существенных финансовых и репутационных потерь, а также привести к необходимости тратить много времени на переработку кода. Средства безопасности, которые можно использовать с управлением API Azure, включают авторизацию пользователя OAuth 2.0 и интеграцию с идентификатором Microsoft Entra.
  • Ценовые категории. Управление API предлагает уровни с разными возможностями для пропускной способности запросов, обслуживания, сетевой изоляции, гибкости обновления и т. д. При создании шлюза управления API Azure выберите уровень, соответствующий вашим потребностям.

Настройка службы управления API

Чтобы настроить службу управления API, необходимо выполнить следующие действия:

  1. Создание шлюза управления API. Имя шлюза должно быть глобально уникальным на уровне пространства имен .azure-api.net.
  2. Зарегистрируйте существующий веб-API в шлюзе. После регистрации API будет доступен потребителям в конечной точке <шлюз>.azure-api.net.
  3. Выполните вызов к существующему API через шлюз. Теперь потребители могут вызывать API по URL-адресу конечной точки.