Импорт API SOAP в Управление API и преобразование в REST

Статья
04/04/2024

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

В этой статье показано, как импортировать API SOAP в виде спецификации WSDL, а затем преобразовать его в REST API. Также здесь показано, как протестировать программный интерфейс в службе "Управление API".

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

Импорт SOAP API и его преобразование в REST
проверка API на портале Azure;

Примечание.

Импорт WSDL в службу Управление API регулируется определенными ограничениями. WSDL-файлы с директивами wsdl:import, xsd:import и xsd:include не поддерживаются. Средство с открытым кодом для разрешения и объединения этих зависимостей в WSDL-файле см. в этом репозитории GitHub.

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

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

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

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

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

В меню слева в разделе API выберите API>+ Добавить API.
В разделе Создание из определения выберите WDSL.
В спецификации WSDL введите URL-адрес SOAP API или нажмите Выбрать файл, чтобы указать расположение локального WSDL-файла.
В методе импорта выберите SOAP в REST. Если выбран этот параметр, в службе управления API выполняется попытка автоматического преобразования между XML и JSON. В этом случае объектам-получателям следует вызывать API как REST API, который возвращает JSON. Управление API преобразует каждый запрос в вызов SOAP.
Следующие поля будут заполнены автоматически информацией из SOAP API: Отображаемое имя, Имя, Описание. Операции заполняются автоматически отображаемым именем, URL-адресом и описанием и получают системное имя.
Введите другие параметры API. Вы можете задать значения во время создания или настроить их позже, перейдя на вкладку Параметры.

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

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

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

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

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

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