Proxy eines SOAP-Dienstes

In dieser Anleitung erfahren Sie, wie Sie einen Edge API-Proxy vor einem SOAP-basierten Webdienst platzieren.

In dieser Anleitung erfahren Sie, wie Sie eine neue RESTful API vor Ihrem SOAP-basierten Dienst generieren. Sie können auch einen Pass-Through-Proxy generieren, der eine SOAP-Nutzlast akzeptiert und an den Back-End-Dienst übergibt, auch wenn dies hier nicht im Detail beschrieben wird.

Voraussetzungen

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

Proxy erstellen

Hier generiert Edge den Proxy, der einem SOAP-Dienst vorangestellt ist. Es gibt zwei Arten von SOAP-API-Proxys:

• REST-SOAP-REST Proxytyp generiert eine neue RESTful API mit einer Übersetzungsebene in SOAP. Clients rufen ihn wie andere RESTful-Dienste auf und übergeben die vom Back-End-Dienst benötigten Abfrageparameter. Edge übersetzt dies in die vom Dienst erwartete SOAP-Nutzlast.
• Mit dem Proxytyp Passthrough-Proxy können Clients einfach eine SOAP-Nutzlast übergeben. Auf diese Weise profitieren SOAP-Dienstaufrufe von Edge-Verwaltungsfunktionen.

Proxy testen

Um den von Ihnen erstellten Proxy auszuprobieren, öffnen Sie eine Eingabeaufforderung und verwenden cURL. Geben Sie dabei den folgenden Befehl ein:

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

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

Wenn Ihre Organisation beispielsweise docfood ist, die Umgebung test ist 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 Abfrageparameter „StockSymbol“ eingegeben haben, sollten Sie den aktuellen Preis für Aktie der Klasse C von Alphabet Inc. 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 Proxy für einen SOAP-Dienst mit "REST to SOAP to REST" verwenden, generiert Edge automatisch eine OpenAPI-Spezifikation. Sie können die OpenAPI-Spezifikation verwenden, um eine API-Dokumentation für die API zu generieren.

Die OpenAPI-Spezifikation finden Sie unter der folgenden URL:

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

Zusätzlicher Beitrag: Wie finden Sie heraus, welche Ressource, welches Verb und welche Abfrageparameter Sie verwenden sollen?

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

Ressource und Verb

Beim Erstellen des Proxys haben Sie im API-Proxy-Assistenten gesehen, wie die SOAP-Vorgänge API-Verben und -Ressourcen zugeordnet werden würden. Wenn Sie diese jedoch nicht aufgeschrieben haben, erfahren Sie das so, nachdem der Proxy erstellt wurde.

Auf dem Tab Entwickeln des API-Proxys wird im linken Navigationsbereich eine Liste von Abläufen unter den Proxyendpunkten angezeigt. Klicken Sie auf den gewünschten Ablauf. Der Ablauf GetQuote eignet sich z. B. gut. Sehen Sie sich dann die XML-Datei im Codebereich an, die den Ressourcenpfad und das Verb für den Ablauf im <Condition>-Element enthält: /quote und GET.

Abfrageparameter

Klicken Sie bei ausgewähltem Ablauf GetQuote auf die erste Richtlinie in der grafischen Ablaufansicht. Es sollte eine Richtlinie zum Extrahieren von Variablen sein, mit der Abfrageparameter erfasst werden, die übergeben werden sollen: StockSymbol und LicenseKey. Wenn Sie im Web nach dem SOAP-Dienst suchen, wird angegeben, was als Lizenzschlüssel übergeben werden soll.

Die erfassten Abfrageparameter werden als Variablen gespeichert und von der nächsten Richtlinie zum Erstellen der SOAP-Nachricht verwendet.