Перенос портала API с помощью плана Azure Spring Apps Enterprise в Azure Управление API

Примечание.

Планы "Базовый", "Стандартный" и "Корпоративный" будут устарели начиная с середины марта 2025 г. с 3-летнего периода выхода на пенсию. Рекомендуется перейти в приложения контейнеров Azure. Дополнительные сведения см. в объявлении о выходе на пенсию в Azure Spring Apps.

Стандартный план потребления и выделенного плана будет устарел с 30 сентября 2024 г. с полным завершением работы после шести месяцев. Рекомендуется перейти в приложения контейнеров Azure. Дополнительные сведения см. в статье "Миграция потребления Azure Spring Apps Standard" и выделенного плана в приложения контейнеров Azure.

Эта статья относится к: ❎ Basic/Standard ✅ Enterprise

В этой статье описывается перенос портала API в Azure Управление API.

Azure Управление API предоставляет централизованный интерфейс для просмотра определений API и тестирования определенных маршрутов API непосредственно из браузера. Он также поддерживает единый вход (SSO) для повышения безопасности и простого доступа. Переход с портала API с помощью Azure Spring Apps в Azure Управление API повышает масштабируемость, безопасность и интеграцию с другими службами Azure.

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

• Существующий экземпляр плана Azure Spring Apps Enterprise с включенным порталом API.
• Существующее приложение контейнера Azure. Дополнительные сведения см. в статье Краткое руководство. Развертывание первого приложения-контейнера с помощью портала Azure.

Создание экземпляра управления API

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

1. В портал Azure найдите Управление API в строке поиска.

2. Выберите Управление API службы из результатов и нажмите кнопку "Создать".

3. Введите следующие требуемые сведения.

   • Подписка. Выберите подписку Azure для службы.
   • Группа ресурсов: выберите существующую группу ресурсов или нажмите кнопку "Создать" , чтобы создать новую.
   • Регион: выберите расположение или регион для экземпляра Управление API.
   • Имя ресурса: укажите глобально уникальное имя для экземпляра Управление API.
   • Имя организации: укажите имя вашей организации.
   • Адрес электронной почты администратора: укажите адрес электронной почты, используемый для уведомлений, связанных с экземпляром Управление API.

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

5. Настройте дополнительные параметры, такие как мониторинг и параметры виртуальной сети.

6. Выберите "Проверка и создание ", чтобы просмотреть параметры и проверить конфигурацию.

7. После завершения проверки нажмите кнопку "Создать". Развертывание может занять от 30 до 40 минут.

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

Импорт предоставленных API в Управление API

Существует два варианта импорта API в Управление API: ручное добавление API или импорт файла спецификации API.

Добавление API вручную

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

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

2. На панели "Определение нового API" выберите параметр HTTP, чтобы вручную определить HTTP-API.

3. Укажите следующие значения API Basics и нажмите кнопку "Создать ", чтобы сохранить:

   • Отображаемое имя: укажите имя API.
   • Имя. Введите уникальный идентификатор ДЛЯ API.
   • URL-адрес веб-службы: укажите базовый URL-адрес внутреннего API приложений контейнеров.
   • Суффикс URL-адреса API: определите суффикс для этого API, например /api/customers-service.

4. Чтобы создать новые конечные точки API, выберите "Добавить операцию", а затем выполните следующие действия:

   1. Укажите общие сведения. Отображаемое имя и имя ввода.
   2. Укажите сведения об операции, например HTTP-командеGET - , POSTи т. д. URL-адрес, параметры запроса, запрос и ответ.
   3. После добавления всех операций сохраните API.

5. Выберите имена добавленных API. Все операции, добавленные на вкладке "Конструктор ".

Импорт файла спецификации API

Если у вас есть спецификация OpenAPI — определение Swagger — api-интерфейсов, вы можете напрямую импортировать в Управление API, выполнив следующие действия:

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

2. Откройте раздел API в разделе API.

3. Выберите " Добавить API".

4. Для создания из определения выберите параметр OpenAPI , который создает стандартный, не зависящий от языка интерфейс интерфейсов REST API.

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

   1. Если у вас есть файл спецификации локального API, выберите файл для отправки файла. Кроме того, укажите общедоступный URL-адрес спецификации OpenAPI.
   2. Вы можете дополнительно уточнить параметры API, указав значения для суффикса суффикса отображаемого имени, имени и URL-адреса API.
   3. Чтобы сохранить конфигурации, нажмите кнопку "Создать".

6. Выберите имя добавленных API. Все операции, добавленные на вкладке "Конструктор ".

Попробуйте использовать API в Управление API

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

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

2. В разделе API выберите API, который вы хотите протестировать из списка.

3. Выберите операцию. На странице обзора API можно просмотреть список доступных операций (конечных точек). Выберите операцию, которую необходимо проверить.

4. Выберите вкладку "Тест", чтобы открыть ее в портал Azure.

5. Настройка параметров запроса. Введите необходимые параметры для запроса, например параметров пути, параметров запроса, заголовков или текста в зависимости от метода API. Если ДЛЯ API требуется, Authorization Tokenобязательно включите его в заголовок.

6. Отправьте запрос. После предоставления сведений о запросе нажмите кнопку "Отправить". Ответ api отображается непосредственно в портал Azure, включая код ответа, текст ответа и заголовки.

7. Проверьте ответ. Просмотрите данные ответа, коды состояния и любые сообщения об ошибках, которые могут указывать на проблемы с API или запросом.

Перенос единого входа в Управление API

Если вы включите единый вход на портале API и хотите выполнить проверку подлинности запросов на Управление API, выполните следующие действия, чтобы настроить удостоверение в Управление API:

1. В портал Azure перейдите к Управление API экземпляру.

2. Перейдите к удостоверениям портала>разработчика.

3. Выберите "Добавить " и выберите Azure Active Directory.

4. Заполните обязательные поля:

   • Идентификатор клиента: приложение или идентификатор клиента зарегистрированного приложения Microsoft Entra ID.
   • Секрет клиента: секрет приложения Идентификатора Microsoft Entra.
   • Клиент signin: доменное имя вашего клиента Идентификатора Microsoft Entra, например yourcompany.onmicrosoft.com
   • URL-адрес перенаправления: обычно https://{your-apim-instance}.developer.azure-api.net/signin.

5. Нажмите кнопку "Добавить ", чтобы сохранить поставщика удостоверений.

Перед сохранением нового добавленного поставщика удостоверений необходимо добавить URL-адрес перенаправления в список разрешенных URL-адресов клиентского приложения Microsoft Entra ID.

Дополнительные конфигурации для Управление API см. в документации по Управление API.