Proxy eines SOAP-Dienstes

In dieser Anleitung erfahren Sie, wie Sie einen Edge API-Proxy vor einem SOAP-basierten Web dienst einfügen.

In dieser Anleitung wird veranschaulicht, wie Sie eine neue RESTful API vor Ihrem SOAP-basierten Dienst generieren. Obwohl hier nicht im Detail beschrieben, können Sie auch einen Passthrough-Proxy generieren, der eine SOAP-Nutzlast akzeptiert und an den Backend-Dienst weiterleitet.

Voraussetzungen

• Ein Apigee Edge-Konto. Wenn Sie noch kein Konto haben, können Sie sich wie unter Apigee Edge-Konto erstellen beschrieben registrieren.

Proxy erstellen

Hier lassen Sie Edge den Proxy generieren, der vor einem SOAP-Dienst platziert wird. Es gibt zwei Arten von SOAP API-Proxys:

• Der Proxytyp REST-SOAP-REST generiert eine neue RESTful API mit einer Übersetzungsebene zu SOAP. Clients rufen sie wie andere RESTful-Dienste auf und übergeben die Suchparameter die vom Backend-Dienst benötigt werden. Edge übersetzt dies in die SOAP-Nutzlast die vom Dienst erwartet wird.
• Mit dem Proxytyp Passthrough-Proxy können Clients einfach eine SOAP-Nutzlast übergeben. So können SOAP-Dienstaufrufe von den Edge-Verwaltungsfunktionen profitieren.

Proxy testen

Um den erstellten Proxy zu testen, öffnen Sie eine Eingabeaufforderung und verwenden Sie cURL. Geben Sie den folgenden Befehl ein, wobei:

• „ORG“ der Name der Edge-Organisation ist, in der Sie den Proxy erstellt haben.
• „ENV“ die Umgebung ist, in der der Proxy bereitgestellt wird.
• „DOMAIN“ der Edge-Instanz entspricht, die Sie verwenden.

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

Wenn Ihre Organisation beispielsweise docfood ist, die Umgebung test und Sie die Edge Enterprise Cloud verwenden, führen Sie einen Befehl wie diesen aus:

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

Wenn Sie GOOG für den Suchparameter „StockSymbol“ eingegeben haben, sollten Sie den aktuellen Kurs der Alphabet Inc. Class C-Aktie erhalten. Beispiel:

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

Automatisch generierte OpenAPI Spezifikation abrufen

Wenn Sie einen SOAP-Dienst mit "REST zu SOAP zu REST" per Proxy vermitteln, generiert Edge automatisch eine OpenAPI-Spezifikation. Sie können die OpenAPI-Spezifikation verwenden, um eine API-Dokumentation für die API zu generieren.

Rufen Sie einfach diese URL auf, um die OpenAPI-Spezifikation zu erhalten:

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

Zusatzaufgabe: Wie finden Sie heraus, welche Ressource, welches Verb und welche Suchparameter verwendet werden müssen?

Im Test-API-Aufruf haben Sie eine bestimmte Ressource und Suchparameter in Ihrem cURL-Aufruf an den Backend-SOAP-Dienst verwendet. Aber wie würden Sie das selbst herausfinden?

Ressource und Verb

Im API-Proxy-Assistenten beim Erstellen des Proxys haben Sie gesehen, wie die SOAP-Vorgänge API-Verben und -Ressourcen zugeordnet werden. Wenn Sie diese jedoch nicht notiert haben, erfahren Sie hier, wie Sie sie nach dem Erstellen des Proxys herausfinden.

Auf dem Tab Entwickeln des API-Proxys sehen Sie im linken Navigationsbereich eine Liste von Abläufen unter „Proxy-Endpunkte“. Klicken Sie auf den gewünschten Ablauf. Der Ablauf GetQuote ist beispielsweise eine gute Wahl. Sehen Sie sich dann die XML-Datei im Bereich „Code“ an. Dort werden der Ressourcenpfad und das Verb für den Ablauf im Element <Condition> angezeigt: /quote und GET.

Suchparameter

Wählen Sie den Ablauf GetQuote aus und klicken Sie in der grafischen Ablaufansicht auf die erste Richtlinie. Es sollte eine Richtlinie zum Extrahieren von Variablen sein, die Suchparameter erfasst, die übergeben werden müssen: StockSymbol und LicenseKey. Wenn Sie im Web nach dem SOAP-Dienst suchen, erfahren Sie, was Sie für den Lizenzschlüssel übergeben müssen.

Die erfassten Suchparameter werden als Variablen gespeichert und von der nächsten Richtlinie verwendet, um die SOAP-Nachricht zu erstellen.