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

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

В этой статье описаны процессы импорта веб-приложения Azure в Управление API Azure и тестирования импортированного API на портале Azure.

Примечание.

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

Вы узнаете, как выполнять следующие задачи:

• импорт веб-приложения в Службу приложений;
• проверка API на портале Azure;

Предоставление веб-приложения через Управление API

Служба приложений Azure — это служба на базе HTTP для размещения веб-приложений, интерфейсов REST 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://myappservice.azurewebsites.net/customer/{id}
• https://myappservice.azurewebsites.net/customers

Вы импортируете это веб-приложение в службу "Управление API" с путем https://contosoapi.azureapi.net/store. В приведенной ниже таблице перечислены операции, которые импортируются в Управление API при наличии и при отсутствии спецификации OpenAPI.

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

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

Необходимые компоненты

• Выполните задачи в кратком руководстве по созданию экземпляра службы управления API Azure.

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

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

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

Перейдите к экземпляру службы управления API.

1. На портале Azure найдите и выберите службы Управление API.

   

2. На странице Службы Управления API выберите экземпляр Управления API.

   

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

Совет

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

1. На портале Azure перейдите к службе "Управление API" и в меню выберите Интерфейсы API.

2. Щелкните в открывшемся списке элемент Служба приложений.

   

3. Щелкните элемент Обзор, чтобы получить список служб приложений в подписке.

4. Выберите нужную Службу приложений. Если с выбранным веб-приложением связано определение OpenAPI, Управление API извлечет его и импортирует.

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

5. Добавьте суффикс URL-адреса API. Суффиксом называется имя, которое идентифицирует конкретный API в экземпляре службы "Управление API". Он должен быть уникальным в пределах экземпляра службы управления API.

6. Чтобы опубликовать API, его нужно связать с определенным продуктом. В нашем случае используется продукт Без ограничений. Если вы планируете опубликовать API и предоставить разработчикам доступ к нему, добавьте его в продукт. Это можно сделать во время создания API или позже.

   Примечание.

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

   По умолчанию каждый экземпляр API управления поставляется с двумя демонстрационными продуктами:

   • Starter
   • Unlimited

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

8. Нажмите кнопку создания.

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

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

1. Выберите API, созданный на предыдущем шаге.

2. Откройте вкладку Тест.

3. Выберите операцию.

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

4. Нажмите кнопку Отправить.

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

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

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

/api/TodoItems

Чтобы протестировать путь /api/TodoItems, выполните описанные ниже действия.

1. Выберите созданный API и нужную операцию.

2. Откройте вкладку Тест.

3. В разделе Параметры шаблона измените значение рядом с именем подстановочного знака (*). Например, введите api/TodoItems. Это значение будет добавляться к пути / для операций с подстановочными знаками.

   

4. Выберите Отправить.

Добавление других интерфейсов API

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

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

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

Примечание.

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

1. Перейдите в свой экземпляр службы "Управление API" на портале Azure.

   

2. Выберите API на странице Обзор или в меню слева.

   

3. Щелкните ...рядом с API, к которому нужно добавить другой API.

4. В раскрывающемся меню выберите Импорт.

   

5. Выберите службу, из которой следует импортировать API.

   

См. также

• Ограничения импорта API
• Импорт спецификации OpenAPI
• Импорт SOAP API
• Импорт SOAP API и его преобразование в REST
• Импорт API Службы приложений
• Импорт API контейнерного приложения
• Импорт API WebSocket
• Импорт API GraphQL
• Импорт схемы GraphQL и настройка сопоставителей полей
• Импорт приложения-функции Azure
• Импорт приложения логики Azure
• Импорт службы Service Fabric
• Импорт API OpenAI Azure
• Импорт API OData
• Импорт метаданных SAP OData
• Импорт API gRPC
• Изменение API

Следующие шаги

Преобразование и защита опубликованного API