Tutorial: REST-API-Definition erstellen, die einen vorhandenen SOAP-Service aufruft

Online bearbeiten

In diesem Tutorial wird dargestellt, wie Sie einen vorhandenen SOAP-Service zugänglich machen und die vom ihm zurückgegebenen XML-Daten in angegebene JSON-Daten konvertieren.

Info zu diesem Tutorial

Folgen Sie dieser Anleitung, um eine REST-API in API Manager zu erstellen, indem Sie die WSDL für einen vorhandenen SOAP-Dienst importieren. Die beiden Standards SOAP 1.1 und SOAP 1.2 werden von API Connect unterstützt. Beim Aufrufen gibt die API den Kontostand eines fiktiven Bankkontos für einen bestimmten Benutzer zurück.

In diesem Tutorial schließen Sie die folgenden Lerneinheiten ab:
  1. REST-API-Definition konfigurieren
  2. API-Definition testen

Vorbereitende Schritte

Hinweis: Der Sandbox-Katalog muss so konfiguriert sein, dass er entweder ein DataPower® API Gateway oder ein DataPower Gateway (v5 compatible) oder beides verwendet. Siehe Kataloge erstellen und konfigurieren.

REST-API-Definition konfigurieren

Führen Sie die folgenden Schritte durch, um eine REST-API zu konfigurieren, die einen bereits vorhandenen SOAP-Service aufruft.

  1. Laden Sie die SOAP WSDL-Datei AccountServicing.txt herunter. Benennen Sie diese Datei in AccountServicing.wsdl um.
  2. Melden Sie sich bei der API Manager UI an.
  3. Klicken Sie auf die Kachel APIs und Produkte entwickeln.

    API-Manager-Bildschirm

  4. Klicken Sie auf „Hinzufügen“ > „API“ (aus REST, „ GraphQL “ oder SOAP).

    API-Menü hinzufügen

  5. Stellen Sie sicher, dass OpenAPI 2.0 ausgewählt ist.
  6. Wählen Sie Vom vorhandenen WSDL-Service (REST-Proxy) aus. Klicken Sie auf Weiter.

    REST-Proxy erstellen

  7. Ziehen Sie im Abschnitt Dateiupload entweder die Datei AccountServicing.wsdl in den Bereich und legen Sie sie dort ab (Drag and Drop) oder klicken Sie auf den Bereich, um eine Datei aus Ihrem Dateisystem hochzuladen.

    WSDL-Bestätigungsbildschirm

  8. Die Datei wird hochgeladen und von API Connect geparst. Es wird eine entsprechende Bestätigungsnachricht angezeigt. Klicken Sie auf „Weiter“, um fortzufahren.
  9. Wählen Sie den AccountServicing WSDL-Dienst, und klicken Sie auf Weiter.

    Bildschirm WSDL-Dienst

  10. Lassen Sie die Werte im Abschnitt Info unverändert, und klicken Sie auf Weiter.

    API-Informationen

  11. Wählen Sie im Abschnitt Sichern das Kontrollkästchen API-Aufrufe auf Schlüsselbasis begrenzen aus und wählen Sie im Abschnitt API aktivieren das Kontrollkästchen API aktivieren aus. Klicken Sie auf Weiter (Next).

    API-Sicherheit und Veröffentlichung

  12. Daraufhin erscheint die Anzeige Zusammenfassung, in der die Schritte zum Erstellen und Veröffentlichen Ihrer neuen API aufgelistet werden. Wenn dieser Prozess abgeschlossen ist, wird eine Zusammenfassung der Ergebnisse angezeigt, einschließlich des API-Basisendpunkts und der Berechtigungsnachweise der Sandbox-Testanwendung, die automatisch für die neue API abonniert wird.

    Zusammenfassung der Ergebnisse (oben)

  13. Klicken Sie auf API bearbeiten. Ihre neue API ist nun online.

    Seite gestalten (oben)

Sie haben erfolgreich eine REST-API erstellt, die einen bereits vorhandenen SOAP-Service aufruft, und sie in ein Produkt und einen Plan einbezogen, die zum Testen bereit sind. Die WSDL-Datei hat dabei alle Informationen bereitgestellt, die zum Konfigurieren der API-Eingaben und -Antwort erforderlich waren.

API-Definition testen

Hinweis: Aufgrund von Einschränkungen beim Cross-Origin Resource Sharing ( CORS ) kann das Assembly-Test-Tool nicht mit den Browsern Chrome oder Safari auf der Plattform „ macOS “ Catalina verwendet werden.

Um Ihre API-Definition mit dem API-Manager-Testtool zu testen, führen Sie die folgenden Schritte aus.

  1. Klicken Sie in der „ AccountServicing “-API auf die Registerkarte „Assemble“, um zur Ansicht „Assemble“ zu wechseln, und klicken Sie dann auf das Symbol „Test Das Symbol Test“.

    Zusammenstellungsansicht

    Beachten Sie, dass die Testanzeige nicht weiter unterstützt wird und in einem zukünftigen Release auf die Registerkarte Test verschoben wird.

    Draft comment: jennydavidse
    This section will need to be redone after the new Test tab is available for both gateways.

  2. Die Anzeige Test wird geöffnet und Sie sehen, dass das Standardprodukt und der Standardplan aufgelistet sind, die für die Testkonfiguration erforderlich sind.

    Test-Fenster

  3. Wählen Sie im Abschnitt „Operation“ die aufzurufende Operation „post /getBalance “ aus.

    Operation auswählen

  4. Blättern Sie in der Anzeige Test abwärts bis zum Feld Anforderung und klicken Sie auf Generieren, um eine Beispielanforderung automatisch zu generieren.

    Anfrage generieren

  5. Klicken Sie auf Aufrufen, um die API zu testen. Die API-Antwort wird im Abschnitt Antwort angezeigt. Wenn Sie eine Nachricht in Bezug auf ein nicht vertrauenswürdiges Zertifikat erhalten, klicken Sie auf den angegebenen Link, akzeptieren Sie das Zertifikat, kehren Sie zur Testumgebung zurück und klicken Sie erneut auf Aufrufen.

    Erfolgreicher Aufruf

    Der Abschnitt Antwort gibt den Kontostand des Kontos erfolgreich zurück.

Die Themen dieses Tutorials

In diesem Tutorial haben Sie die folgenden Aktivitäten durchgeführt:

  • Konfigurieren einer REST-API-Definition.
  • Konfigurieren der API basierend auf einer SOAP-WSDL-Datei, um einen bereits vorhandenen Web-Service aufzurufen und seine Ausgabe zurückzugeben.
  • Testen Ihrer API-Definition.