Proxy dla SOAP

Z tego samouczka dowiesz się, jak umieścić proxy interfejsu API Edge przed usługą internetową opartą na protokole SOAP.

Ten samouczek pokazuje, jak wygenerować nowy interfejs API RESTful przed usługą opartą na protokole SOAP. Chociaż nie jest to tutaj szczegółowo opisane, możesz też wygenerować proxy typu pass-through które akceptuje ładunek SOAP i przekazuje go do usługi backendu.

Czego potrzebujesz

• Konto Apigee Edge. Jeśli jeszcze go nie masz, możesz się zarejestrować, postępując zgodnie z instrukcjami w artykule Tworzenie konta Apigee Edge.

Tworzenie proxy

W tym miejscu Edge wygeneruje proxy, które będzie znajdować się przed usługą SOAP. Istnieją 2 typy proxy interfejsu API SOAP:

• Typ proxy REST-SOAP-REST generuje nowy interfejs API RESTful z warstwą tłumaczenia na SOAP. Klienci wywołują go tak jak inne usługi RESTful, przekazując parametry zapytania wymagane przez usługę backendu. Edge tłumaczy to na ładunek SOAP oczekiwany przez usługę.
• Typ proxy Pass-through proxy umożliwia klientom po prostu przekazywanie ładunku SOAP. Dzięki temu wywołania usługi SOAP mogą korzystać z funkcji zarządzania Edge.

Testowanie proxy

Aby przetestować utworzone proxy, otwórz wiersz polecenia i użyj cURL. Wpisz to polecenie poniżej, gdzie:

• ORG to nazwa organizacji Edge, w której utworzono proxy.
• ENV to środowisko, w którym wdrożono proxy.
• DOMAIN odpowiada używanej instancji Edge.

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

Jeśli na przykład Twoja organizacja to docfood, środowisko to test, a Ty korzystasz z chmury dla przedsiębiorstw Edge, uruchom polecenie takie jak to:

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

Jeśli w parametrze zapytania StockSymbol wpiszesz GOOG, powinna się wyświetlić aktualna cena akcji klasy C firmy Alphabet Inc. Na przykład:

{  
   "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
      }
   }
}

Pobieranie automatycznie wygenerowanej specyfikacji OpenAPI

Gdy tworzysz proxy usługi SOAP za pomocą opcji "REST to SOAP to REST," Edge automatycznie generuje specyfikację OpenAPI. Możesz użyć specyfikacji OpenAPI, aby wygenerować dokumentację API dla interfejsu API.

Aby pobrać specyfikację OpenAPI, otwórz ten adres URL:

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

Dodatkowe informacje: jak znaleźć zasób, czasownik i parametry zapytania, których należy użyć?

W testowym wywołaniu interfejsu API użyłeś(-aś) konkretnego zasobu i parametrów zapytania w wywołaniu cURL do usługi SOAP backendu. Ale jak to samodzielnie sprawdzić?

Zasób i czasownik

W kreatorze proxy interfejsu API podczas tworzenia proxy widziałeś(-aś), jak operacje SOAP są mapowane na czasowniki i zasoby interfejsu API. Jeśli jednak nie zapisałeś(-aś) tych informacji, możesz je znaleźć po utworzeniu proxy.

Na karcie Develop (Tworzenie) proxy interfejsu API w panelu nawigacyjnym po lewej stronie zobaczysz listę przepływów w sekcji Proxy Endpoints (Punkty końcowe proxy). Kliknij interesujący Cię przepływ. Dobrym przykładem jest przepływ GetQuote. Następnie wyświetl XML w panelu Code (Kod), który pokazuje ścieżkę zasobu i czasownik dla przepływu w elemencie <Condition> (Warunek): /quote i GET.

Parametry zapytania

Gdy wybierzesz przepływ GetQuote, kliknij pierwszą zasadę w graficznym widoku przepływu. Powinna to być zasada Extract Variables (Wyodrębnij zmienne), która przechwytuje parametry zapytania, które mają być przekazywane: StockSymbol i LicenseKey. (Jeśli wyszukasz w internecie usługę SOAP, dowiesz się, co należy przekazać w przypadku LicenseKey).

Przechwycone parametry zapytania są zapisywane jako zmienne i używane przez następną zasadę do utworzenia wiadomości SOAP.