[Tutorial] SOAP-APIs in REST-APIs umwandeln

SOAP Web Services und REST APIs sind zwei beliebte Technologien, die von Webentwicklern verwendet werden. Da SOAP APIs jedoch langsam durch den REST-Architekturstil ersetzt werden, gibt es Möglichkeiten, die vorhandenen SOAP Web Services zu nutzen?

Bevor wir uns mit den technischen Details der Konvertierung einer SOAP API in eine REST API befassen, werden wir eine Einführung in SOAP APIs und REST APIs geben und die Unterschiede und Stärken von SOAP und REST APIs erläutern.

Was sind SOAP APIs?

SOAP (Simple Object Access Protocol) APIs folgen einem standardisierten Protokoll, das vom World Wide Web Consortium (W3C) festgelegt wurde. Ähnlich wie andere APIs werden SOAP APIs implementiert, um Informationen zwischen verschiedenen Anwendungen und Systemen auszutauschen.

SOAP API Hauptmerkmale

• XML-basiert: SOAP APIs basieren auf XML (Extensible Markup Language), um Daten in Anfragen und Antworten zu strukturieren. Dies gewährleistet ein konsistentes und klar definiertes Format für die Kommunikation.
• Strukturiert und formell: Im Vergleich zu anderen API-Stilen sind SOAP APIs strukturierter und formeller. Sie definieren jede Operation, ihre Parameter und die erwartete Struktur der Antworten eindeutig mithilfe einer Datei namens WSDL (Web Services Description Language).
• Zuverlässig und sicher: SOAP APIs sind für ihre Zuverlässigkeit und Sicherheit bekannt. Sie verwenden häufig Verschlüsselung und digitale Signaturen, um eine sichere Datenübertragung zu gewährleisten.

Häufige Anwendungsfälle für SOAP APIs

Finanzdienstleistungen: Der Finanzsektor ist stark auf den sicheren und zuverlässigen Datenaustausch angewiesen. SOAP APIs mit ihren robusten Sicherheitsfunktionen und dem strukturierten Datenformat eignen sich gut für Aufgaben wie:

• Interbankenkommunikation
• Sichere Geldtransfers
• Kreditkartenverarbeitung

Lieferkettenmanagement: Effektive Lieferketten hängen von einem nahtlosen Informationsaustausch zwischen verschiedenen Unternehmen ab. SOAP APIs können dies erleichtern durch:

• Freigabe von Lagerbeständen
• Kommunikation von Bestellstatus
• Verfolgung von Sendungen

Integration von Altsystemen: Moderne Anwendungen müssen oft mit älteren Systemen interagieren, denen moderne API-Funktionen fehlen. SOAP APIs fungieren als diese Brücke durch:

• Offenlegung der Funktionalitäten von Altsystemen
• Integration dieser Funktionalitäten in neuere Workflows

Was sind REST APIs?

REST (Representational State Transfer) APIs, gelegentlich auch RESTful APIs genannt, folgen dem REST-Architekturstil.

REST API Hauptmerkmale

• Zustandslos: SOAP APIs sind bekanntermaßen zustandslos, was bedeutet, dass jede von einer Anwendung an den Server gesendete Anfrage alle notwendigen Informationen zur Verarbeitung enthält und der Server keine Informationen über den Zustand früherer Interaktionen speichert. Dies macht SOAP APIs skalierbar und für Entwickler intuitiv verständlich.
  
• Ressourcenbasiert: REST APIs interagieren mit Ressourcen, die mithilfe von Uniform Resource Identifiers (URIs) identifiziert werden. Diese Ressourcen könnten reale Entitäten wie Benutzer, Produkte und Aktionen darstellen.
  
• Standard-HTTP-Methoden: REST APIs nutzen Standard-HTTP-Methoden wie GET, POST, PUT und DELETE für verschiedene Operationen.
  GET: Ruft Informationen über eine Ressource ab.
  POST: Erstellt eine neue Ressource.
  PUT: Aktualisiert eine vorhandene Ressource.
  DELETE: Löscht eine Ressource.
  
• Leichtgewichtig und flexibel: Im Vergleich zu SOAP APIs werden REST APIs im Allgemeinen als leichter und flexibler angesehen. Sie sind einfacher einzurichten, zu verwenden und in verschiedene Anwendungen und Plattformen zu integrieren.

Häufige Anwendungsfälle für REST APIs

Mobile Anwendungen: Mobile Anwendungen verlassen sich auf REST APIs, um mit Backend-Servern zu interagieren. Diese Interaktion ermöglicht es ihnen, Folgendes zu tun:

• Daten abrufen: Informationen wie Produktlisten, Nachrichten-Updates oder Benutzerprofile abrufen. Wenn die REST API mit React erstellt wurde, können Sie möglicherweise auch die Fetch API verwenden, um beim Abrufen von Daten zu helfen.
• Aktionen ausführen: Artikel zu einem Warenkorb hinzufügen, Kommentare posten oder Formulare absenden.
• Benutzerinformationen senden: Standortdaten, Benutzereinstellungen oder Anmeldeinformationen freigeben.

Webanwendungen: Viele Webanwendungen, sowohl Single-Page- als auch traditionelle, verwenden REST APIs, um mit Webservern und Datenbanken zu kommunizieren. Diese Kommunikation ermöglicht es ihnen, Folgendes zu tun:

• Inhalte abrufen: Dynamische Inhalte wie Suchergebnisse, personalisierte Empfehlungen oder benutzergenerierte Inhalte abrufen.
• Benutzer authentifizieren: Benutzern erlauben, sich anzumelden, ihre Konten zu verwalten und Benutzerdaten zu verwalten.
• Daten verwalten: Daten wie Artikel, Benutzerprofile oder Produktinformationen erstellen, aktualisieren und löschen.

Social-Media-Plattformen: Im Mittelpunkt der Social-Media-Interaktion steht der Informationsaustausch, der durch REST APIs ermöglicht wird. Diese APIs ermöglichen es Benutzern, Folgendes zu tun:

• Inhalte teilen: Updates, Stories und andere Medieninhalte posten.
• Miteinander interagieren: Inhalte anderer Benutzer liken, kommentieren und teilen.
• Auf Plattformfunktionalitäten zugreifen: Funktionen wie Messaging, Erstellen von Gruppen und Verwalten von Kontoeinstellungen nutzen.

Warum APIs von SOAP zu REST konvertieren?

Abgesehen von einem der Hauptfaktoren, dass SOAP APIs viel komplexer zu verwenden und zu verstehen sind, gibt es noch andere Gründe, warum viele Entwickler ihre SOAP APIs aktualisieren und in REST APIs umwandeln.

1. Einfachheit und Benutzerfreundlichkeit: REST APIs gelten im Allgemeinen als einfacher und benutzerfreundlicher als SOAP APIs. REST verwendet Standard-HTTP-Methoden wie GET, POST, PUT und DELETE, die den meisten Entwicklern vertraut sind.

SOAP basiert sowohl für Anfragen als auch für Antworten auf XML, was im Vergleich zu JSON oder anderen Datenformaten, die üblicherweise in REST APIs verwendet werden, komplexer sein kann.

2. Flexibilität und Skalierbarkeit: REST APIs sind flexibler und skalierbarer als SOAP APIs, da REST ressourcenbasiert ist und ein modulareres und anpassungsfähigeres Design ermöglicht. Neue Funktionalitäten können durch die Einführung neuer Ressourcen und URIs hinzugefügt werden.

Inzwischen ist SOAP nachrichtenbasiert, was es weniger flexibel und potenziell komplexer macht, wenn die API wächst.

3. Breitere Akzeptanz und Werkzeuge: REST APIs werden breiter akzeptiert und unterstützt als SOAP APIs.

• Viele Entwicklungstools, Frameworks und Bibliotheken stehen für das Erstellen und Interagieren mit REST APIs zur Verfügung.
• Dieses breitere Ökosystem vereinfacht die Entwicklung und Integration sowohl für REST API-Anbieter als auch für -Konsumenten.

4. Moderne Entwicklungspraktiken: REST APIs passen besser zu modernen Entwicklungspraktiken und -trends:

• REST APIs sind tendenziell leichter, was zu einer schnelleren Kommunikation und einer verbesserten Benutzererfahrung der Anwendung führt.
• Die zustandslose Natur von REST APIs erleichtert Caching- und Load-Balancing-Strategien.

5. Verbesserte Entwicklererfahrung: Insgesamt kann die Konvertierung in eine REST API die Entwicklererfahrung in mehrfacher Hinsicht verbessern:

• Einfachere Lernkurve: Entwickler mit Erfahrung in der Interaktion mit Web APIs werden REST APIs intuitiver und leichter zu erlernen finden.
• Erhöhte Produktivität: Die Verfügbarkeit von Tools und Support für REST APIs kann zu einer schnelleren Entwicklung und einfacheren Wartung führen.
• Breitere Community-Unterstützung: Entwickler können von einer breiteren Online-Community und leicht verfügbaren Ressourcen für die Fehlerbehebung und das Lernen profitieren.

SOAP und REST API Codebeispiele (Ein Vergleich)

Dieser Abschnitt zeigt SOAP- und REST APIs mithilfe der Programmiersprache Python und bietet die gleiche Funktionalität: Abrufen von Produktinformationen basierend auf der ID. (Bitte beachten Sie, dass das Kopieren des unten bereitgestellten Codebeispiels möglicherweise nicht unbedingt auf Ihrem Gerät funktioniert, also stellen Sie sicher, dass Änderungen vorgenommen werden.)

SOAP API (mit der zeep-Bibliothek für die Kommunikation):

from zeep import Client

# Ersetzen Sie dies durch die tatsächliche WSDL-URL der SOAP API
wsdl_url = "https://example.com/soap/product?wsdl"

# Erstellen Sie einen SOAP-Client
client = Client(wsdl_url)

# Produkt-ID, für die Informationen abgerufen werden sollen
product_id = 123

# Definieren Sie den Operationsnamen
operation_name = "GetProductDetails"

# Senden Sie die SOAP-Anfrage mit der Produkt-ID als Parameter
response = client.service[operation_name](productId=product_id)

# Produktname und Preis aus der Antwort extrahieren (unter der Annahme der Struktur)
product_name = response["productName"]
product_price = response["price"]

print(f"Produktname: {product_name}")
print(f"Produktpreis: {product_price}")

SOAP API Erklärung:

1. Importieren Sie die zeep-Bibliothek: Diese Bibliothek erleichtert die Kommunikation mit SOAP APIs in Python.
2. Definieren Sie die WSDL-URL: Wenn Sie das Codebeispiel verwenden möchten, können Sie https://example.com/soap/product?wsdl durch die tatsächliche WSDL-URL der SOAP API ersetzen, mit der Sie interagieren möchten.
3. Erstellen Sie einen SOAP-Client: Das Client-Objekt  zeep wird mit der WSDL-URL erstellt.
4. Operationsnamen definieren: Der Operationsname für die SOAP API ist GetProductDetails.
5. Anfrage senden: Die SOAP-Anfrage wird mit der Produkt-ID als Parameter gesendet und die gewünschten Daten aus der Antwort extrahiert.

REST API (mit der requests-Bibliothek):

import requests

# Ersetzen Sie dies durch die tatsächliche Basis-URL der REST API
base_url = "https://example.com/api/products"

# Produkt-ID, für die Informationen abgerufen werden sollen
product_id = 123

# Erstellen Sie die API-Endpunkt-URL mit der spezifischen Produkt-ID
url = f"{base_url}/{product_id}"

# Senden Sie eine GET-Anfrage an den REST API-Endpunkt
response = requests.get(url)

# Auf erfolgreiche Antwort prüfen (Statuscode 200)
if response.status_code == 200:
  # Die JSON-Antwortdaten parsen (unter der Annahme des JSON-Formats)
  data = response.json()
  product_name = data["name"]
  product_price = data["price"]
  print(f"Produktname: {product_name}")
  print(f"Produktpreis: {product_price}")
else:
  print(f"Fehler beim Abrufen der Produktinformationen: {response.status_code}")

REST API Erklärung:

1. Importieren Sie requests:  Die requests-Bibliothek wird verwendet, um mit der REST API zu interagieren.
2. Basis-URL definieren: Die spezifische Endpunkt-URL für das gewünschte Produkt wird erstellt, indem die Produkt-ID am Ende der URL angefügt wird.
3. Eine Anfrage senden: Die REST API sendet eine Anfrage an den Endpunkt und prüft, ob sie eine erfolgreiche Antwort erhält.
4. Daten parsen: Bei Erfolg werden die Daten aus der JSON-Antwort zum Extrahieren geparst, andernfalls wird die erfolglose Antwort verarbeitet.

Wichtige Unterschiede zwischen SOAP- und REST-Prozessen

Anhand der Codebeispiele ist ersichtlich, dass es Unterschiede gibt in:

• Kommunikationsprotokoll: SOAP verwendet SOAP-Nachrichten über HTTP, während REST Standard-HTTP-Methoden wie GET verwendet und Datenformate wie JSON oder XML verwendet.
• Datenformat: SOAP verwendet XML sowohl für Anfragen als auch für Antworten, während REST üblicherweise JSON oder andere Formate verwendet.
• Struktur: SOAP basiert auf WSDL zur Definition der API, während REST auf klar definierte URIs und Standard-HTTP-Methoden basiert.

Wie man SOAP APIs in REST APIs umwandelt?

Obwohl es, wie aus den Codebeispielen ersichtlich ist, möglich ist, dass sowohl SOAP- als auch REST APIs mit derselben Clientsprache ausgeführt werden, unterscheiden sich die Zusammensetzung, die Protokolle und die Struktur so stark, dass dies eine sehr komplexe Methode wäre.

Es gibt jedoch wesentliche Schritte, um SOAP APIs in REST APIs umzuwandeln, egal wie einfach oder komplex die SOAP API ist.

1. Analysieren Sie die SOAP API:

• Verstehen Sie die WSDL: Untersuchen Sie das WSDL-Dokument gründlich. Es definiert Operationen, Parameter und erwartete Antwortstrukturen.
• Ressourcen identifizieren: Ordnen Sie die Funktionalitäten und Daten, die in der API enthalten sind, relevanten „Ressourcen“ im RESTful-Sinne zu. Diese Ressourcen stellen Entitäten wie Benutzer, Produkte oder Aktionen dar.
• Operationen HTTP-Methoden zuordnen: Bestimmen Sie die am besten geeignete HTTP-Methode (GET, POST, PUT, DELETE) für jede Operation basierend auf ihrem Zweck (Abrufen, Erstellen, Aktualisieren, Löschen von Ressourcen).

2. Entwerfen Sie die REST API:

• Definieren Sie RESTful URIs: Erstellen Sie klare und beschreibende URIs für den Zugriff auf Ressourcen mithilfe der Standardsyntax. Diese URIs sollten die Hierarchie und Beziehungen zwischen Ressourcen widerspiegeln.
  
  Beispiel: /products/{id} zum Abrufen eines bestimmten Produkts nach ID.
  
• Datenformate definieren: Wählen Sie ein geeignetes Datenformat für Anforderungs- und Antwort-Payloads, üblicherweise JSON oder XML. Berücksichtigen Sie Faktoren wie die Kompatibilität mit Ihrer Anwendung sowie die Größe und Komplexität der Daten.
• Dokumentieren Sie die API: Dokumentieren Sie die REST API mithilfe eines Standardformats wie OpenAPI (Swagger) oder Postman Collection. Diese Dokumentation wird zu einer Referenz für Entwickler, die mit Ihrer API interagieren möchten.

3. Implementierung:

• Entwickeln Sie den API-Server: Implementieren Sie die Logik zur Verarbeitung von Anfragen und Antworten basierend auf dem definierten RESTful-Design. Dies beinhaltet typischerweise das Erstellen einer Serveranwendung mit der von Ihnen gewählten Programmiersprache und dem Framework.
• Datenkonvertierung verarbeiten: Implementieren Sie die Logik zur Übersetzung zwischen SOAP- und REST-Datenformaten (falls erforderlich). Dies könnte das Parsen von SOAP-Nachrichten und deren Konvertierung in das gewählte REST-Format (z. B. JSON) für Antworten umfassen.

4. Testen und Bereitstellen:

• Testen Sie die REST API gründlich: Stellen Sie sicher, dass sie die Funktionalität der ursprünglichen SOAP API genau widerspiegelt und sich an RESTful-Prinzipien hält.
• Stellen Sie die REST API bereit: Machen Sie die API für Entwickler verfügbar, indem Sie sie auf einer geeigneten Plattform oder Serverumgebung bereitstellen.

Apidog - Konvertieren Sie SOAP in REST mit 1 Klick

Apidog ist ein umfassendes, Design-First-orientiertes API-Tool für Entwickler zum Erstellen von APIs. Mit Apidog können API-Entwickler APIs erstellen, testen, dokumentieren und simulieren.

Wenn Sie Ihre SOAP APIs anzeigen möchten, um sie in REST APIs umzuwandeln, ist Apidog genau das Richtige für Sie. Mit der Erleichterung von Änderungen und Spezifikationen für den gesamten API-Lebenszyklus kann Apidog jeden Bedarf unterstützen, den ein API-Entwickler sucht.

Importieren einer SOAP-bezogenen WSDL-Datei in Apidog

Unter Einstellungen können Sie WSDL-Dateien importieren, indem Sie den Abschnitt Daten importieren auswählen.

Exportieren von SOAP zu REST mit Apidog

Nachdem Daten aus der WSDL-Datei importiert wurden, können Sie alle Daten Ihrer SOAP API in Apidog sehen. Sie können sie nach Bedarf ändern.

Mit Apidog können Sie Ihre kürzlich importierten WSDL-Dateien in JSON-Dateien konvertieren, indem Sie sie exportieren. Durch den Export können Sie die SOAP APIs als JSON-Dateien speichern, wodurch sie technisch in REST konvertiert werden (da SOAP APIs in XML-Markup vorliegen).

Um den Dateiexport zu starten, klicken Sie mit der rechten Maustaste auf eine API, die Sie konvertieren möchten. Suchen Sie dann nach Exportieren und drücken Sie darauf.

Wählen Sie abschließend die Option OpenAPI (Swagger), um die SOAP API als JSON-Datei zu exportieren.

Fazit

Obwohl die Konvertierung von SOAP APIs in REST APIs viel Aufwand erfordert, wird dies für viele API- und Webentwickler zu einer Notwendigkeit. SOAP APIs werden langsam von REST APIs überschattet, da REST APIs skalierbar und flexibel sind. Darüber hinaus sind REST APIs viel einfacher zu verstehen und zu implementieren als SOAP APIs.

Mit Apidog ist es möglicherweise möglich, SOAP APIs in REST APIs umzuwandeln. Durch das Importieren von WSDL-Dateien und deren Export als OpenAPI- oder Swagger-Dateien können Sie SOAP APIs in einem JSON-Dateityp erhalten. Wenn Sie mehr über die Struktur Ihrer SOAP API erfahren möchten, können Sie auch deren Details in Apidog anzeigen und weitere Tests und Debugging damit durchführen.