Импорт веб-приложения Azure в качестве API

Статья
2025-04-04

ОБЛАСТЬ ПРИМЕНЕНИЯ: Все уровни API Управления

В этой статье показано, как использовать портал Azure для импорта веб-приложения Azure в качестве API в службу управления API Azure и тестирования импортированного API.

Примечание.

В настоящее время эта функция недоступна в рабочих областях.

В этой статье вы узнаете, как:

Импорт веб-приложения, размещенного в Службе приложений Azure, в качестве API
проверка API на портале Azure;

Открытие веб-приложения через управление API

Служба приложений Azure — это служба на базе HTTP для размещения веб-приложений, интерфейсов REST API и внутренней части мобильных решений. Разработчики API могут использовать свои предпочитаемые стеки технологий и конвейеры для разработки API и публикации внутренних серверных элементов API в качестве веб-приложений в безопасной масштабируемой среде. Затем они могут использовать управление API для предоставления веб-приложений, управления и защиты API на протяжении всего жизненного цикла и публикации их потребителям.

Использование службы управления API для предоставления API, размещенного в веб-приложениях, обеспечивает следующие преимущества:

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

Дополнительные сведения см. в статье Сведения об Управлении API.

OpenAPI и операции с подстановочными знаками

Управление API поддерживает импорт веб-приложений, размещенных в службе приложений, включающих определение OpenAPI (определение Swagger). Однако определение OpenAPI не требуется.

Если веб-приложение настроено с определением OpenAPI, управление API обнаружит это. Кроме того, можно вручную импортировать определение в Управление API. Управление API затем создает операции API, которые соответствуют определению напрямую, включая необходимые пути, параметры и типы ответов.

Определение OpenAPI рекомендуется, так как API импортируется в управление API с высокой точностью, что обеспечивает гибкость для проверки, управления, защиты и обновления конфигураций для каждой операции отдельно.
Если определение OpenAPI не указано, Управление API создает операции с подстановочными символами для общих HTTP-команд (GET, PUT и т. д.). Добавьте требуемый путь или параметры к операциям с подстановочными знаками, чтобы передать запрос API в серверную часть API.

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

Пример

Серверный веб-приложение может поддерживать две операции GET:

https://<app-service>.azurewebsites.net/customer/{id}
https://<app-service>.azurewebsites.net/customers

Вы импортируете веб-приложение в службу управления API по пути https://<api>.azureapi.net/store. В следующей таблице показаны операции, импортированные в службу управления API, с спецификацией OpenAPI или без нее:

Тип	Импортируемые операции	Примеры запросов
Спецификация OpenAPI	`GET /customer/{id}` `GET /customers`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`
Подстановочный знак	`GET /*`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`

Операция с подстановочными знаками позволяет выполнять те же запросы к бэкенд-службе, что и операции в спецификации OpenAPI. Но операциями, определенными через OpenAPI, вы можете управлять в службе "Управление API" раздельно.

Предварительные условия

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

Сведения о создании примера веб-API и его публикации в качестве веб-приложения Azure см. в следующих статье:
- Руководство. Создание веб-API с помощью ASP.NET Core.
- Публикация приложения ASP.NET Core в Azure с помощью Visual Studio Code.

Импорт и публикация API серверной части

Совет

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

Перейдите к службе Управления API на портале Azure.
В меню слева в разделе API выберите API и нажмите кнопку +Добавить API.
Выберите плитку Службы приложений :
Выберите "Обзор" , чтобы просмотреть список служб приложений в подписке.
Выберите службу приложений и нажмите кнопку "Выбрать ". Если определение OpenAPI связано с выбранным веб-приложением, управление API извлекает его и импортирует его.

Если определения OpenAPI в нем нет, Управление API будет использовать для предоставления этого API операции с подстановочными знаками для самых распространенных HTTP-команд.
Добавьте суффикс URL-адреса API. Суффикс — это имя, определяющее API в экземпляре управления API. Он должен быть уникальным в экземпляре управления API.
Если вы хотите, чтобы API был опубликован и доступен разработчикам, перейдите в полное представление и свяжите API с продуктом. В этом примере используется неограниченный продукт. (Вы можете добавить API в продукт при его создании или более поздней версии с помощью вкладки "Параметры ".)
Примечание.

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

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

Проверка нового API на портале Azure

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

Выберите API, созданный на предыдущем шаге.
На вкладке "Тест" выберите операцию.

На странице отобразятся поля для параметров запроса и для заголовков. Одним из заголовков является Ocp-Apim-Subscription-Key. Этот заголовок предназначен для ключа подписки продукта, связанного с API. Если вы создали экземпляр службы управления API, вы уже являетесь администратором, поэтому ключ заполняется автоматически.
Нажмите кнопку Отправить.

Если тест пройдет успешно, приложение серверной части передаст код ответа 200 — OK и некоторые данные.

Проверка операции с подстановочными символами на портале

Если создаются операции с подстановочными знаками, они не всегда будут напрямую сопоставляться с API серверной части. Например, в импортированных через Управление API операциях GET с подстановочными знаками по умолчанию используется путь /. Однако серверный API может поддерживать операцию GET по пути /api/todoItems.

Чтобы проверить путь /api/todoItems:

Выберите созданный API и выберите операцию.
На вкладке "Тест" в разделе "Параметры шаблона" измените значение рядом с подстановочным знаком (*). Например, введите api/todoItems. Это значение добавляется к пути / для операции с подстановочными знаками.
Выберите Отправить.

Присоединение других API

Вы можете создавать API из API, предоставляемых различными службами, в том числе:

Спецификация OpenAPI
A SOAP API
A GraphQL API
Веб-приложение, размещенное в службе приложений Azure
Функции Azure
Приложения логики Azure
Azure Service Fabric

Примечание.

При импорте API операции добавляются к текущему API.

Чтобы добавить API к существующему API, выполните следующие действия.

Перейдите к инстансу службы Управление API Azure на портале Azure.
Выберите API на странице обзора или выберите API> в меню слева.
Выберите многоточие (...) рядом с API, к которому требуется добавить другой API.
Выберите Импорт в раскрывающемся меню:
Выберите службу, из которой следует импортировать API.