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

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

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

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

Вы научитесь:

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

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

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

Примечание.

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

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

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

   

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

   

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

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

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

2. В списке Добавление нового API выберите Приложение-функция.

   

3. Выберите Обзор, чтобы выбрать функции, которые нужно импортировать.

   

4. Выберите раздел Приложение-функция, чтобы выбрать из списка доступных приложений-функций.

   

5. Найдите приложение-функцию, из которого нужно импортировать функции, щелкните его и нажмите кнопку Выбрать.

   

6. Выберите функции, которые требуется импортировать, и щелкните Выбрать.

   • Вы можете импортировать исключительно функции, основанные на триггере HTTP с уровнями авторизации Анонимный или Функция.

   

7. Переключитесь в полное представление и назначьте продукт вашему новому API.

8. При необходимости задайте значения в других полях во время создания или позже, перейдя на вкладку Параметры.

   • Эти параметры описаны в руководстве Импорт и публикация первого интерфейса API.

   Примечание.

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

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

   • Starter
   • Unlimited

9. Нажмите кнопку Создать.

Добавление приложения-функции Azure к существующему API

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

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

2. Выберите API, в который нужно импортировать приложение-функцию Azure. Щелкните ... и выберите Импорт в контекстном меню.

   

3. Выберите плитку Приложение-функция.

   

4. Во всплывающем окне щелкните Обзор.

   

5. Выберите раздел Приложение-функция, чтобы выбрать из списка доступных приложений-функций.

   

6. Найдите приложение-функцию, из которого нужно импортировать функции, щелкните его и нажмите кнопку Выбрать.

   

7. Выберите функции, которые требуется импортировать, и щелкните Выбрать.

   

8. Нажмите кнопку Импорт.

   

Авторизация

Во время импорта приложения-функции Azure автоматически создается:

• ключ узла в приложении-функции с именем apim-{имя экземпляра службы "Управление API Azure"};
• именованное значение в экземпляре службы "Управление API Azure" с именем {имя экземпляра приложения-функции Azure}-key, которое содержит созданный ключ узла.

При использовании интерфейсов API, созданных после 4 апреля 2019 г., ключ узла передается в HTTP-запросе от службы "Управление API" к приложению-функции в заголовке. Более старые API передают ключ узла в виде параметра запроса. Данный алгоритм можно изменить с помощью PATCH Backendвызова REST API для объекта Backend, связанного с приложением-функцией.

Предупреждение

Удаление или изменение значения ключа узла приложения-функции Azure или именованного значения управления API Azure нарушит обмен данными между службами. Значения не синхронизируются автоматически.

Если вам нужно сменить ключ узла, измените также именованное значение в службе "Управление API Azure".

Доступ к ключу узла приложения-функции Azure

1. Перейдите к экземпляру приложения-функции Azure.

   

2. В разделе Функции бокового навигационного меню выберите Клавиши приложения.

   

3. Найдите ключи в разделе Ключи хоста.

   

Доступ к именованному значению в службе "Управление API Azure"

Перейдите к экземпляру службы "Управление API Azure" и в меню слева щелкните Именованные значения. Здесь хранится ключ приложения-функции Azure.

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

Операции можно вызывать непосредственно на портале Azure. Использование портала Azure — удобный способ просмотра и тестирования операций с API.

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

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

3. Выберите операцию, которую необходимо проверить.

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

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

   • При успешном завершении теста серверная часть отвечает сообщением 200 OK и предоставлением определенных данных.

См. также

• Ограничения импорта 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