Как проксировать сервис SOAP

В этом руководстве рассказывается, как разместить прокси-сервер API Edge перед веб-сервисом на основе SOAP.

В этом руководстве показано, как создать новый RESTful API для сервиса на основе SOAP. Здесь не приводится подробное описание, но вы также можете создать сквозной прокси-сервер, который принимает полезную нагрузку SOAP и передает ее в бэкенд-службу.

Что вам понадобится

• Аккаунт Apigee Edge. Если у вас его ещё нет, вы можете зарегистрироваться, следуя инструкциям в разделе Создание аккаунта Apigee Edge.

Как создать прокси-сервер

Здесь Edge сгенерирует прокси-сервер, который будет находиться перед сервисом SOAP. Существует два типа прокси SOAP API:

• Прокси-сервер типа REST-SOAP-REST создает новый RESTful API с уровнем преобразования в SOAP. Клиенты вызывают его так же, как и другие сервисы RESTful, передавая параметры запроса, необходимые для бэкенд-службы. Edge преобразует его в полезную нагрузку SOAP, ожидаемую сервисом.
• Прокси-сервер с передачей данных позволяет клиентам просто передавать полезную нагрузку SOAP. Это позволяет использовать функции управления Edge для вызовов сервисов SOAP.

Как проверить прокси-сервер

Чтобы протестировать созданный прокси-сервер, откройте командную строку и используйте cURL. Введите команду, указанную ниже, где:

• ORG – это название организации Edge, в которой вы создали прокси.
• ENV – это среда, в которой развернут прокси.
• DOMAIN соответствует экземпляру Edge, который вы используете.

curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Например, если ваша организация – docfood, среда – test, а вы используете корпоративное облако Edge, выполните команду, похожую на следующую:

curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Если вы ввели GOOG в качестве параметра запроса StockSymbol, то должны получить текущую цену акций класса C компании Alphabet Inc. Пример:

{  
   "GetQuoteResponse":{  
      "GetQuoteResult":{  
         "StockSymbol":"GOOG",
         "LastTradeAmount":819.55,
         "LastTradeDateTime":"2017-02-13T14:33:00",
         "StockChange":5.88,
         "OpenAmount":816.0,
         "DayHigh":820.96,
         "DayLow":815.49,
         "StockVolume":785064,
         "PrevCls":813.67,
         "ChangePercent":"+0.72%",
         "FiftyTwoWeekRange":"663.28 - 841.95",
         "EarnPerShare":27.88,
         "PE":29.4,
         "CompanyName":"Alphabet Inc.",
         "QuoteError":false
      }
   }
}

Как получить автоматически сгенерированную спецификацию OpenAPI

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

Чтобы получить спецификацию OpenAPI, перейдите по следующему URL:

curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json

Дополнительный вопрос. Как узнать, какие ресурсы, глаголы и параметры запроса нужно использовать?

В тестовом вызове API вы использовали определенный ресурс и параметры запроса в вызове cURL к серверному SOAP-сервису. Но как узнать это самостоятельно?

Ресурс и глагол

В мастере прокси-сервера API при создании прокси вы видели, как операции SOAP будут сопоставляться с глаголами и ресурсами API. Если вы не записали их, то можете узнать их после создания прокси-сервера.

На вкладке Develop (Разработка) прокси API на левой панели навигации вы увидите список потоков в разделе Proxy Endpoints (Конечные точки прокси). Нажмите на нужный поток. Например, это может быть последовательность действий GetQuote (Получить предложение). Затем посмотрите XML-код в области "Код". В элементе <Condition> указаны путь к ресурсу и глагол для потока:/quote и GET.

Параметры запроса

Выберите поток GetQuote и нажмите на первое правило в графическом представлении потока. Это должно быть правило извлечения переменных, которое захватывает параметры запроса, которые должны быть переданы: StockSymbol и LicenseKey. (Если вы выполните поиск по запросу "сервис SOAP", то узнаете, что нужно передать в качестве LicenseKey.)

Захваченные параметры запроса сохраняются как переменные и используются следующим правилом для создания сообщения SOAP.