Импорт и публикация API

  • 5 мин

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

В рассматриваемом примере компания-производитель обуви NorthWind Shoes планирует предоставить некоторым своим партнерам возможность запрашивать сведения об объеме запасов на складе.

Здесь вы узнаете, как импортировать API в Azure Управление API и как сделать API доступным для клиентов.

API

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

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

  • Протестируйте API с помощью средств визуализации в шлюзе API.
  • Реализовать управление доступом к API с помощью политик.

Платформы API

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

Тип Сведения
HTTP Вы можете импортировать HTTP-API с пустым определением API. После этого можно вручную задать все необходимые параметры.
WebSocket Настройте сквозную передачу в серверную службу WebSocket.
GraphQL Настройте сквозную передачу в серверную службу GraphQL или импортируйте схему GraphQL и создайте искусственный API GraphQL с настраиваемыми разрешениями полей.
OpenAPI OpenAPI — это спецификация, которая документирует все конечные точки и операции для API RESTful, а также все входные и выходные параметры. Спецификация OpenAPI изначально носила название Swagger.
WADL Язык описания веб-приложений (WADL) представляет собой описание основанных на протоколе HTTP веб-служб в формате XML. Это более простой формат и более упрощенный, чем язык описания веб-службы.
WSDL Язык описания веб-службы (WSDL) представляет собой описание любой сетевой службы (не только HTTP) в формате XML.

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

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

Импорт API

Импортировать API в службу управления API Azure можно несколькими способами.

С помощью портала Azure, выбрав команду API и затем +Добавить API. Сначала выберите тип API, который вы хотите импортировать.

Снимок экрана портала Azure, на котором показана служба управления API с выделенным и выбранным разделом API-интерфейсов

Затем необходимо предоставить ссылку на API в качестве URL-адреса или файла, а также имя API. Ниже приведен пример импорта OpenAPI.

Снимок экрана создания элементов из параметров импорта спецификации OpenAPI с выделенными полями

Портал Azure является не самым эффективным инструментом для импорта и настройки большого количества API. При масштабировании управления API требуются другие средства, такие как Azure CLI, шаблоны Azure Resource Manager или Bicep или Azure PowerShell. Например, можно использовать командлеты Azure PowerShell для развертывания шлюзов API, определения и настройки продуктов, импорта API и управления пользователями и подписками.

Визуализировать

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

Администраторы также могут визуализировать API на портале Azure.

Снимок экрана конфигурации API на портале Azure, на котором показан выделенный тест запроса GET для импортированного API

Политики

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

К популярным конфигурациям относятся следующие:

  • Преобразование из формата XML в JSON
  • Ограничение количества входящих вызовов по частоте.
  • Установка входящих и исходящих заголовков.

Применение различных политик к API с помощью портала Azure. Политики можно просмотреть на вкладке Конструктор.

Снимок экрана портала Azure, на котором показана конфигурация API для всех операций с базовыми политиками, выделенными для входящих, исходящих и внутренних разделов

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

Снимок экрана с порталом Azure, на котором показаны параметры политики входящего трафика для конфигурации API.

Продукт

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

Продукт NorthWindShoesPartners
API 1 Запасы
API 2 Планирование

При этом поставщикам может предоставляться только один API:

Продукт NorthWindShoesSuppliers
API 1 Запасы
API 2

Назначая политики своим продуктам, вы можете определять различные правила доступа, квоты и условия использования. Таким образом, если вы планируете предоставить партнерам и поставщикам разные права доступа к API Inventory, следует назначить этот API двум разным продуктам.

Для связывания API с продуктом используется портал Azure.

Снимок экрана портала Azure, на котором показана служба

В нескольких ценовых категориях существует два продукта по умолчанию: Starter и Unlimited. Безлимитный план рассчитан на управление API в рабочей среде и не имеет ограничений по количеству связанных API. В этом случае вы можете создавать любое количество новых продуктов. Начальный продукт имеет ограничение в пять вызовов API в минуту и не более 100 вызовов API в неделю.