Предоставление службы SOAP в качестве прокси-сервера API

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

В этом разделе объясняется, как создавать прокси-серверы API для веб-служб на основе SOAP. В Edge вы можете создать два типа прокси-серверов SOAP. Один генерирует интерфейс RESTful для серверной службы SOAP, а другой выполняет «сквозную передачу» сообщения SOAP на серверную часть. Оба метода описаны в этой теме.

В этом видеоролике представлена ​​комплексная демонстрация превращения службы SOAP в службу REST с помощью Apigee Edge с помощью мастера прокси-сервера API. Однако если вам нужен больший контроль над преобразованием SOAP в REST, вы можете создать прокси-сервер с помощью политик. Дополнительные сведения см. в разделе Учебное пособие: Создание прокси-сервера SOAP-to-REST API вручную в Apigee Edge .

Создание прокси-сервера RESTful API для службы на основе SOAP

В этом разделе объясняется, как создать прокси-сервер RESTful SOAP API с помощью параметра REST to SOAP to REST в мастере создания прокси.

Обзор

Параметр REST to SOAP to REST обрабатывает WSDL для создания прокси-сервера RESTful API. Edge определяет из WSDL операции, поддерживаемые службой, входные параметры и т. д. Edge «угадывает», какой метод HTTP использовать для каждой операции. Обычно Edge преобразует операции в запросы GET, преимуществом которых является возможность кэширования. Edge также настраивает целевую конечную точку серверной части, которая может варьироваться в зависимости от операции SOAP.

Для этого типа прокси Edge автоматически генерирует спецификацию OpenAPI , которую вы можете использовать для создания документации по API.

Основные шаги

Край

Чтобы создать прокси-сервер RESTful API для службы на основе SOAP с помощью пользовательского интерфейса Edge:

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Разработка» > «Прокси API» на левой панели навигации.
  3. Нажмите +Прокси .
  4. Нажмите Служба SOAP .
  5. На странице сведений о прокси укажите файл WSDL.
    Поле Описание
    Предоставьте файл WSDL

    Выберите источник WSDL.

    • С веб-адреса (URL) — введите или вставьте URL-адрес WSDL.
    • С моего компьютера — загрузите файл WSDL из локального каталога. Вы можете загрузить несколько файлов, если есть зависимости.
  6. Нажмите «Проверить» , чтобы проверить WSDL.
  7. Введите следующие данные прокси:
    Поле Описание
    Имя Имя, отображаемое для вашего API. Укажите буквенно-цифровые символы, тире (-) или подчеркивание (_).
    Базовый путь

    Фрагмент URI, который появляется после адреса http(s)://[host] вашего прокси API. Edge использует URI базового пути для сопоставления и маршрутизации входящих сообщений запроса на соответствующий прокси-сервер API.

    ПРИМЕЧАНИЕ . Базовый путь прокси-сервера API по умолчанию равен значению, указанному в поле Name , преобразованному в нижний регистр.

    После базового пути идут URL-адреса любых дополнительных ресурсов. Вот полная структура URL-адресов, которую клиенты будут использовать для вызова вашего прокси-сервера API:

    https://[host]/ base_path / conditional_flow_path

    ПРИМЕЧАНИЕ . Базовый путь должен быть уникальным; вы не можете развернуть два прокси-сервера API с одним и тем же базовым путем. Если вы редактируете развернутый прокси-сервер API и устанавливаете для базового пути то же значение, что и для базового пути другого прокси-сервера API, Edge автоматически отменяет развертывание прокси-сервера API при его сохранении. Прежде чем вы сможете повторно развернуть прокси-сервер API, необходимо изменить базовый путь, чтобы он был уникальным.

    Используйте подстановочные знаки в базовых путях

    Используйте один или несколько подстановочных знаков /*/ в базовых путях прокси API, чтобы подготовить свои прокси API к будущему. Например, базовый путь /team/*/members позволяет клиентам вызывать https://[host]/team/ blue /members и https://[host]/team/ green /members без необходимости создавать новые Прокси API для поддержки новых команд. Обратите внимание, что /**/ не поддерживается.

    Описание (Необязательно) Описание API.
  8. Нажмите Далее .
  9. На странице мастера «Общие политики» настройте следующие параметры:
    • Требования к авторизации безопасности в разделе Безопасность: Авторизация . См. Добавление безопасности .
    • Поддержка совместного использования ресурсов между источниками (CORS) в разделе «Безопасность: браузер» . См . Добавление поддержки CORS .
    • Квоты для защиты вашей серверной службы от большого трафика в рамках Quota . См. Квоты . (Недоступно, если выбрана сквозная авторизация.)
  10. На странице операций WSDL выберите тип прокси-сервера API REST to SOAP to REST .

    Появится таблица со списком операций, которые Edge «обнаружил» в файле WSDL. Вы можете выбрать и настроить, какие операции вы хотите включить в свой прокси-сервер API. Таблица представлена ​​на следующем рисунке.

  11. Выберите тип порта из раскрывающегося списка, чтобы указать, какой набор операций вы хотите использовать. В WSDL элементы типа порта определяют операции, которые вы можете вызывать в веб-службе.
  12. При необходимости измените путь REST API для операции. Путь будет использоваться в качестве имени ресурса в URL-адресе прокси-сервера API.
  13. При необходимости измените глагол (метод HTTP), связанный с операцией.
  14. Нажмите Далее .
  15. На странице мастера «Виртуальные хосты» выберите виртуальные хосты, к которым будет привязан прокси-сервер API при развертывании. Дополнительную информацию см. в разделе О виртуальных хостах .
  16. Нажмите Далее .
  17. Выберите среду(ы) развертывания и нажмите «Создать и развернуть».
    Ваш новый прокси-сервер API будет создан и развернут в выбранной среде.
  18. Нажмите «Редактировать прокси» , чтобы отобразить страницу сведений о прокси-сервере API.

Классический Edge (частное облако)

Чтобы создать прокси-сервер RESTful API для службы на основе SOAP с помощью классического пользовательского интерфейса Edge:

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите API > Прокси API на верхней панели навигации.
  3. Нажмите + Прокси-сервер API .
  4. В мастере создания прокси выберите службу SOAP.
  5. Нажмите Далее .
  6. На странице «Сведения» выберите эти параметры. После выбора WSDL необходимо нажать «Проверить» .
    В этой области сделай это
    WSDL

    Выберите источник WSDL.

    • URL — введите URL-адрес WSDL, который вы хотите использовать.
    • Файл — выберите файл WSDL в вашей файловой системе. В случаях, когда есть дополнительные зависимые файлы, вы можете выбрать их все.
    • Пример URL-адреса — выберите из списка WSDL для общедоступных веб-служб. Они удобны для тестирования функций прокси-сервера SOAP/API Edge.
    Имя прокси

    Это имя прокси, который вы создаете.

    Базовый путь прокси-сервера

    Фрагмент URI, который появляется после адреса http(s)://[host] вашего прокси API. Edge использует URI базового пути для сопоставления и маршрутизации входящих сообщений запроса на соответствующий прокси-сервер API.

    Примечание . Базовый путь прокси-сервера API по умолчанию равен значению, указанному в поле Name , преобразованному в нижний регистр.

    После базового пути идут URL-адреса любых дополнительных ресурсов. Вот полная структура URL-адресов, которую клиенты будут использовать для вызова вашего прокси-сервера API:

    https://[host]/ base_path / conditional_flow_path

    Примечание . Базовый путь должен быть уникальным; вы не можете развернуть два прокси-сервера API с одним и тем же базовым путем. Если вы редактируете развернутый прокси-сервер API и устанавливаете для базового пути то же значение, что и для базового пути другого прокси-сервера API, Edge автоматически отменяет развертывание прокси-сервера API при его сохранении. Прежде чем вы сможете повторно развернуть прокси-сервер API, необходимо изменить базовый путь, чтобы он был уникальным.

    Используйте подстановочные знаки в базовых путях

    Используйте один или несколько подстановочных знаков /*/ в базовых путях прокси API, чтобы обеспечить безопасность ваших прокси API в будущем. Например, базовый путь /team/*/members позволяет клиентам вызывать https://[host]/team/ blue /members и https://[host]/team/ green /members без необходимости создавать новые API-прокси для поддержки новых команд. Обратите внимание, что /**/ не поддерживается.

    Описание Краткое описание прокси.
  7. Нажмите Далее .
  8. На странице WSDL выберите тип прокси API REST to SOAP to REST .

    Появится таблица со списком операций, которые Edge «обнаружил» в файле WSDL. Вы можете выбрать и настроить, какие операции вы хотите включить в свой прокси-сервер API. Таблица представлена ​​на следующем рисунке.

    На странице операций WSDL тип прокси-сервера API установлен на REST для SOAP для REST, а в таблице показана одна строка результатов операции добавления.

  9. Выберите в столбце «Тип порта», какой набор операций вы хотите использовать. В WSDL элементы типа порта определяют операции, которые вы можете вызывать в веб-службе.
  10. При необходимости измените метод HTTP, связанный с операцией.

    Примечание. Edge делает «наилучшее предположение» при определении метода HTTP, который будет использоваться для каждой операции. GET обычно предпочтительнее, поскольку запросы GET можно кэшировать.
  11. При необходимости измените путь REST API для операции. Путь будет использоваться в качестве имени ресурса в URL-адресе прокси-сервера API.
  12. Пройдите оставшуюся часть мастера, чтобы добавить безопасность, выбрать виртуальные хосты и среду развертывания.
  13. На странице «Сборка» нажмите «Сборка и развертывание» . Edge генерирует и развертывает новый прокси-сервер API на основе WSDL.
  14. Перейдите на страницу сводки нового прокси-сервера API. Обратите внимание, что набор ресурсов был создан на основе операций, обнаруженных в файле WSDL.

    На странице «Обзор» прокси-сервера в списке «Ресурсы» представлено подробное описание нового API, его операций и параметров. Вы можете рассматривать это представление как справочную документацию API. Edge автоматически генерирует для вас это представление модели API. Просто разверните ресурс, чтобы увидеть его описание и информацию о пути.

О финальном прокси

Когда Edge генерирует прокси-сервер API на основе WSDL, полученный прокси-сервер на самом деле представляет собой сложный поток, включающий политики для преобразования данных, извлечения и установки переменных, управления сообщениями и многого другого. После создания прокси-сервера на основе WSDL взгляните на полученный поток в представлении «Разработка» пользовательского интерфейса управления API. Там вы можете увидеть, какие именно политики были добавлены.

Например, на стороне запроса политика AssignMessage используется для установки целевого URL-адреса. На стороне ответа выполняются политики для преобразования ответа из XML в JSON, извлечения части тела ответа SOAP в переменную и установки ответного сообщения. Эти политики (и другие) добавляются автоматически при создании прокси.

Спецификация OpenAPI . Чтобы просмотреть автоматически созданную спецификацию OpenAPI для этого прокси-сервера, посетите http(s)://[proxy_domain]/[proxy_base_path]/openapi.json . Однако преобразование не всегда является точным, поскольку не все правила схемы XML могут быть представлены в спецификации OpenAPI.

Создание сквозного прокси для службы на основе SOAP

В этом разделе объясняется, как создать сквозной прокси с помощью параметра «Сквозной прокси» в диалоговом окне «Создать новый прокси».

Обзор

Параметр сквозного прокси позволяет создать прокси-сервер, который передает сообщение SOAP в запросе к внутренней службе «нетронутым», что упрощает создание прокси-сервера для веб-службы на основе SOAP. За кулисами Edge автоматически обрабатывает любые преобразования и другие действия потока. Например, если запрос имеет формат JSON, Edge предпринимает шаги по преобразованию его в допустимое XML-сообщение SOAP с правильными пространствами имен перед отправкой его в службу POST. Аналогичным образом, когда служба возвращает ответ SOAP на основе XML, Edge преобразует его обратно в JSON, прежде чем вернуть клиенту. Кроме того, Edge настраивает целевую конечную точку серверной части, которая может варьироваться в зависимости от операции SOAP.

Для этого типа прокси Edge размещает WSDL и создает поток в прокси, чтобы вы могли получить к нему доступ. Адрес этого WSDL, размещенного на Edge, http(s)://[proxy_domain]/[proxy_base_path]?wsdl , становится новым URL-адресом конечной точки службы для клиентов, вызывающих службу SOAP через прокси.

Основные шаги

Край

Чтобы создать сквозной прокси-сервер для службы на основе SOAP с помощью пользовательского интерфейса Edge:

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Разработка» > «Прокси API» на левой панели навигации.
  3. Нажмите +Прокси .
  4. Нажмите Служба SOAP .
  5. На странице сведений о прокси укажите сведения о WSDL.
    Поле Описание
    WSDL

    Выберите источник WSDL.

    • С веб-адреса (URL) — введите или вставьте URL-адрес WSDL.
    • С моего компьютера — загрузите файл WSDL из локального каталога. Вы можете загрузить несколько файлов, если есть зависимости.
    Имя

    Имя прокси-сервера API.

    Базовый путь

    Фрагмент URI после адреса http(s)://[host] вашего прокси API. Edge использует URI базового пути для сопоставления и маршрутизации входящих сообщений запроса на соответствующий прокси-сервер API.

    Примечание . Рекомендации Apigee по управлению версиями API см. в электронной книге « Версии в дизайне веб-API: недостающее звено» .

    После базового пути указываются URL-адреса дополнительных ресурсов. Вот полная структура URL-адресов, которую клиенты будут использовать для вызова вашего прокси-сервера API:

    https://[host]/ base_path /conditional_flow_path

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

    Использование подстановочного знака в базовых путях

    Вы можете использовать один или несколько подстановочных знаков /*/ в базовых путях прокси-серверов API, чтобы подготовить свои прокси-серверы к будущему. Например, базовый путь /team/*/members позволяет клиентам вызывать https://[host]/team/ blue /members и https://[host]/team/ green /members без необходимости создавать новые API-прокси для поддержки новых команд. Обратите внимание, что /**/ не поддерживается.

    Примечание . Базовый путь прокси-сервера API по умолчанию равен значению, указанному в поле «Имя», преобразованному в нижний регистр, если вы явно не отредактируете содержимое поля «Базовый путь».

    Описание (Необязательно) Описание API.
  6. Нажмите Далее .
  7. На странице мастера «Общие политики» настройте следующие параметры:
  8. На странице WSDL выберите тип прокси-сервера API Pass-Through SOAP .

  9. Выберите тип порта из раскрывающегося списка, чтобы указать, какой набор операций вы хотите использовать. В WSDL элементы типа порта определяют операции, которые вы можете вызывать в веб-службе.
  10. Нажмите Далее .
  11. На странице мастера «Виртуальные хосты» выберите виртуальные хосты, к которым будет привязан прокси-сервер API при развертывании. Дополнительную информацию см. в разделе О виртуальных хостах .
  12. Выберите среду(ы) развертывания и нажмите «Создать и развернуть».
    Ваш новый прокси-сервер API будет создан и развернут в выбранной среде.
  13. Нажмите «Редактировать прокси» , чтобы отобразить страницу сведений о прокси-сервере API.

Классический Edge (частное облако)

Чтобы создать сквозной прокси-сервер для службы на основе SOAP с помощью классического пользовательского интерфейса Edge:

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите API > Прокси API на верхней панели навигации.
  3. Нажмите + Прокси-сервер API .
  4. В мастере создания прокси выберите службу SOAP.
  5. Нажмите Далее .
  6. На странице «Сведения» выберите эти параметры. После выбора WSDL необходимо нажать «Проверить» .
    В этой области сделай это
    WSDL

    Выберите источник WSDL.

    • URL — введите URL-адрес WSDL, который вы хотите использовать.
    • Файл — выберите файл WSDL в вашей файловой системе. В случаях, когда есть дополнительные зависимые файлы, вы можете выбрать их все.
    • Пример URL-адреса — выберите из списка WSDL для общедоступных веб-служб. Они удобны для тестирования функций прокси-сервера SOAP/API Edge.
    Имя прокси

    Это имя прокси, который вы создаете.

    Базовый путь прокси-сервера Базовый путь прокси — это фрагмент URI, который уникально идентифицирует API, предоставляемый этим прокси API. Службы API используют URI базового пути для сопоставления и маршрутизации входящих сообщений запроса на соответствующий прокси-сервер API. (Базовый путь добавляется к домену API, который автоматически генерируется на основе названия вашей организации и среды , в которой развернут прокси-сервер API.) Рекомендуется включать номер версии в имя проекта, например: /v1/delayedstockquote . Это определит, как ваш API будет вызываться потребительскими приложениями.

    Примечание . Базовый путь прокси-сервера по умолчанию равен значению, указанному для имени прокси-сервера, преобразованному в нижний регистр, если вы явно не отредактируете содержимое поля «Базовый путь прокси-сервера».

    Описание Краткое описание прокси.

  8. Нажмите Далее .
  9. На странице WSDL выберите тип прокси API Pass-Through SOAP .

    Примечание. Появится таблица, в которой перечислены все операции WSDL и соответствующие им полезные данные SOAP. Это полезная нагрузка, которая «передается» серверной службе SOAP.

    На странице WSDL тип прокси-сервера API установлен на сквозной SOAP, а список операций, таких как GetQuote, организован по типам портов.
  10. Выберите в столбце «Тип порта», какой набор операций вы хотите использовать. В WSDL элементы типа порта определяют операции, которые вы можете вызывать в веб-службе.
  11. Пройдите оставшуюся часть мастера, чтобы добавить безопасность, выбрать виртуальные хосты и среду развертывания.
  12. На странице «Сборка» нажмите «Сборка и развертывание» . Edge генерирует и развертывает новый прокси-сервер API на основе WSDL.

О финальном прокси

Когда Edge генерирует сквозной прокси, полученный прокси на самом деле представляет собой сложный поток, включающий политики для преобразования данных, извлечения и установки переменных, управления сообщениями и многого другого. После создания сквозного прокси-сервера просмотрите полученный поток в представлении «Разработка» пользовательского интерфейса управления API. Там вы можете увидеть, какие именно политики были добавлены.

Например, на следующем рисунке показана часть предварительной обработки целевой конечной точки сквозного прокси. На стороне запроса для установки целевого URL-адреса используется политика AssignMessage. На стороне ответа выполняются политики для преобразования ответа из XML в JSON, извлечения части тела ответа SOAP в переменную и установки ответного сообщения. Эти политики (и другие) добавляются автоматически при создании прокси.

В представлении «Разработка» на панели «Поток» стрелки обозначают поток от запроса к ответу, а значки обозначают политики.

WSDL, размещенный на Edge : чтобы просмотреть WSDL, размещенный на Edge, созданный для этого типа прокси, перейдите по адресу http(s)://[proxy_domain]/[proxy_base_path] ?wsdl .

Расширенная разработка прокси-сервера SOAP-to-REST

В предыдущих разделах было описано создание прокси-сервера API SOAP-to-REST с помощью мастера прокси-сервера API в Edge. Однако если вам нужен более детальный контроль над преобразованием SOAP в REST, вы можете обойти автоматизацию, предоставляемую мастером, и создать прокси-сервер, вручную добавив и настроив политики для достижения желаемого поведения. Дополнительные сведения см. в разделе Учебное пособие: Создание прокси-сервера SOAP-to-REST API вручную в Apigee Edge .