[Tutorial] Testen von SOAP-APIs mit Axios

"SOAP Axios" könnte eine Phrase sein, die Sie vielleicht schon einmal gelesen oder gehört haben, wenn es um Webentwicklung geht. Nichtsdestotrotz umfasst die Phrase zwei wichtige Konzepte, die Sie kennen sollten.

Zusammengefügt wird "SOAP Axios" als Entwickler angesehen, die Axios verwenden, um eine SOAP-API zu debuggen.

SOAP - Simple Object Access Protocol

SOAP, auch bekannt als Simple Object Access Protocol, ist ein Protokoll, das die Regeln für die Strukturierung von Nachrichten in der Webentwicklung definiert. Es gewährleistet den Austausch strukturierter Informationen in Webdiensten und -systemen im selben Netzwerk.

Mit dem SOAP-Protokoll ist es für Programme und Anwendungen, die auf verschiedenen Betriebssystemen laufen, möglich, miteinander zu kommunizieren. Schauen Sie sich popular SOAP APIs an, um mehr darüber zu erfahren, was sie tun.

Wichtige Merkmale, die SOAP definieren

Standardisiertes Protokoll: SOAP ist ein standardisiertes Protokoll, das vom World Wide Web Consortium (W3C) verwaltet wird. Diese Standardisierung gewährleistet Konsistenz und Interoperabilität über verschiedene Systeme und Plattformen hinweg.

XML-basierte Nachrichten: SOAP-Nachrichten werden mit XML (eXtensible Markup Language) formatiert, wodurch sie von Menschen und Maschinen leicht gelesen werden können. = XML bietet auch eine gut definierte Struktur für Anfragen und Antworten.

Strenge Spezifikation: SOAP hat eine strenge und gut definierte Spezifikation für die Nachrichtenstruktur, die Header und Body umfasst. Dies kann ein Vorteil in Szenarien sein, in denen ein hohes Maß an Konsistenz und Formalität erforderlich ist.

Eingebaute Fehlerbehandlung: SOAP verfügt über eine eingebaute Fehlerbehandlung durch standardisierte Fehlerelemente. Dies erleichtert die detaillierte Fehlerberichterstattung.

Protokollunabhängigkeit: SOAP-Nachrichten können über verschiedene Transportprotokolle übertragen werden, darunter HTTP, SMTP und mehr. Diese Flexibilität ermöglicht den Einsatz von SOAP in einer Vielzahl von Netzwerkumgebungen.

WSDL-Datei-Dokumentation: WSDL, eine XML-basierte Sprache, wird in der Regel mit einer SOAP-API geliefert, um diese zu beschreiben. Sie beschreibt die Funktionalitäten, Parameter und andere Details, die vom Webdienst bereitgestellt werden, und hilft den Benutzern oder Clients des Webdienstes, den Dienst zu verstehen und mit ihm zu interagieren.

Was ist Axios?

Axios ist eine beliebte JavaScript-Bibliothek, die verwendet wird, um HTTP-Anfragen von einem Webbrowser oder einer Node.js-Umgebung aus zu stellen. Axios wurde entwickelt, um einfach zu sein und die Promise-API zu unterstützen. Dies macht Axios zur Wahl der Entwickler für die Handhabung asynchroner Operationen bei der Arbeit mit APIs.

Die definierenden Merkmale von Axios

Promise-basiert: Axios basiert auf Promises. Die Vereinfachung der Handhabung von asynchronem Code ermöglicht es Entwicklern, sich auf eine sauberere und lesbarere Syntax zu konzentrieren, wodurch es einfacher wird, Antworten und Fehler zu verwalten.

Browser- und Node.js-Unterstützung: Axios ist in Webbrowsern und Node.js-Umgebungen anwendbar, was es zu einer vielseitigen Wahl für Entwickler macht, die an Full-Stack-Anwendungen arbeiten.

Anfrage- und Antwortabfang: Axios ermöglicht es Entwicklern, Anfragen oder Antworten abzufangen und zu modifizieren, bevor sie verarbeitet werden. Diese Funktion ist besonders nützlich für Aufgaben wie das Hinzufügen von Headern zu Anfragen oder die Handhabung von Authentifizierungstoken.

Automatische JSON-Datentransformation: Axios parst automatisch JSON-Antworten und vereinfacht so die Arbeit mit JSON-Daten von APIs.

Gleichzeitigkeitskontrolle: Axios bietet Funktionen wie das Abbrechen von Anfragen, was in Szenarien nützlich sein kann, in denen ein Benutzer von einer Seite navigiert oder eine Aktion abbricht, wodurch unnötige Netzwerkanfragen verhindert werden.

Beispiel für eine einfache Axios HTTP GET-Anfrage

Wenn Sie sich fragen, wie eine Axios HTTP-Anfrage aussehen könnte, hier ist eine einfache GET-Anfrage.

import axios from 'axios';

axios.get('https://api.example.com/data')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error fetching data:', error);
  });

Vorteile der Verwendung von Axios zum Debuggen von SOAP-APIs

HTTP-Anfrage-Inspektion: Axios ermöglicht es Ihnen, die Details der HTTP-Anfrage zu untersuchen, die an die SOAP-API gesendet wird. Die Details der Anfrage umfassen Header, Request-Payload und alle anderen Konfigurationsoptionen. Entwicklern zu ermöglichen, diese Details zu sehen, ist entscheidend für die Identifizierung von Problemen in der Anfragestruktur oder den Headern.

Antwortbehandlung: SOAP-API-Antworten, die nach dem Senden einer Anfrage empfangen werden, sind aufgrund der lesbaren Programmiersprache sehr einfach zu lesen und zu verstehen. Axios bietet auch Zugriff auf Antwortdaten, Header und Statuscodes. Dies hilft beim Verständnis der Antwort des Servers und bei der Identifizierung potenzieller Probleme.

Fehlerbehandlung: Axios ermöglicht es Ihnen, Fehler zu behandeln, die während der HTTP-Anfrage auftreten können. Dies ist wertvoll für das Debuggen von SOAP-API-Aufrufen, da es Ihnen ermöglicht, Fehler abzufangen und zu protokollieren, was Einblicke in das gibt, was während der Kommunikation schief gelaufen ist.

Anfrage- und Antwortabfang: Axios unterstützt das Abfangen von Anfragen und Antworten, sodass Sie die Anfrage oder Antwort ändern können, bevor sie gesendet oder verarbeitet wird. Dies kann nützlich sein, um benutzerdefinierte Header hinzuzufügen, zu protokollieren oder während des Debuggens Anpassungen vorzunehmen.

Verwendung von Axios zum Debuggen von SOAP-APIs

Apidog ist eine API-Plattform, die Webentwickler mit einer Vielzahl von Funktionen unterstützt, vom Entwerfen bis zum Testen von APIs.

Schauen wir uns an, wie Sie Axios mit Apidog verwenden können, um eine SOAP-API zu debuggen. Aber bevor Sie mit diesem Prozess beginnen, stellen Sie sicher, dass Sie Axios auf Bash installiert haben, indem Sie eine der folgenden Codezeilen ausführen

npm install axios
# or
yarn add axios

Erstellen Sie ein Node.js-Skript und führen Sie es aus

Wenn Sie noch keine Node.js-Skriptdatei erstellt haben, können Sie sich auf das Beispiel unten beziehen, das debug-soap-api.js heißt. Achten Sie darauf, die Details entsprechend den Anforderungen Ihrer SOAP-API zu ändern.

// Import Axios
const axios = require('axios');

// Define SOAP endpoint and request payload
const soapEndpoint = 'https://example.com/soap-endpoint';
const soapRequest = `
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"...>
    <!-- Your SOAP request here -->
  </soapenv:Envelope>
`;

// Make a POST request using Axios
axios.post(soapEndpoint, soapRequest, {
  headers: { 'Content-Type': 'text/xml' }
})
.then(response => {
  // Handle the SOAP API response
  console.log('SOAP Response:', response.data);
})
.catch(error => {
  // Handle errors during the SOAP API request
  console.error('SOAP Error:', error);
});

Sobald Sie mit der Konfiguration Ihres Node.js-Skripts fertig sind, führen Sie diese Codezeile auf Bash aus. Achten Sie darauf, den Namen von debug-soap-api.js entsprechend dem tatsächlichen Dateinamen Ihres Node.js-Skripts zu ersetzen.

node debug-soap-api.js

Überprüfen und Kopieren der Ausgabe

Wenn der obige Schritt korrekt ausgeführt wurde, sollten Sie eine Ausgabe auf der Konsole Ihres Computers sehen können. Diese Ausgabe enthält SOAP-API-Antworten. mit allen Fehlern, die während der Anfrage aufgetreten sein könnten.

Wenn Sie glauben, dass diese Ausgabe Ihren Erwartungen entspricht, dann funktioniert Ihre SOAP-API korrekt.

Verwendung von Apidog als Axios-Alternative für SOAP-Tests

Mit Apidog haben Sie die Möglichkeit, jede Webdienst-Anfrage zu testen. Um dies zu tun, werfen Sie einen Blick auf die folgenden Schritte.

Pfeil 1 - Wählen Sie die spezifische Anfrage aus, die ausgewählt werden muss. In diesem Beispiel heißt die ausgewählte Anfrage Success.

Pfeil 2 - Klicken Sie auf die Schaltfläche "Senden", sobald die Anfrage-URL angegeben wurde.

Pfeil 3 - Beobachten Sie die Antwort, die nach dem Senden der Anfrage empfangen wurde.

Verwendung von Apidog zur Generierung von Axios-Client-Code

Sie können die Axios HTTP-Anfrage für die SOAP-API replizieren, indem Sie die Code-Generierungsfunktion von Apidog verwenden.

Befolgen Sie die folgenden Schritte, um zu erfahren, wie Sie sie verwenden können!

Zuerst starten Sie eine neue Anfrage und suchen Sie die Schaltfläche </>, die sich in der oberen rechten Ecke des Bildschirms befindet. Wenn Sie Schwierigkeiten haben, sie zu finden, beziehen Sie sich auf das Bild, wo sie durch den Pfeil oben hervorgehoben wird.

Sobald Sie sie gefunden haben, drücken Sie sie und wählen Sie "Client-Code generieren".

Sie sollten jetzt ein Popup-Fenster mit dem Titel "Code generieren" haben. Hier können Sie "JavaScript" auswählen und "Axios" auswählen, wie im obigen Bild gezeigt.

Jetzt können Sie den Code in Ihre Zwischenablage kopieren und ihn als Skelettstruktur in Axios einfügen, um die Axios HTTP-Anfrage zu erstellen, um Ihre SOAP-API zu debuggen!

Erstellen von Dokumentation für Anfragen in Apidog

Apidog ermöglicht es Benutzern auch, nahtlos API-Dokumentation für Ihre SOAP-API zu erstellen.

Suchen Sie zuerst die Schaltfläche "Teilen", wie durch Pfeil 1 hervorgehoben, und drücken Sie die Schaltfläche "+ Neu", wie durch Pfeil 2 hervorgehoben

Apidog bietet die Möglichkeit, auszuwählen, wer Ihre API-Dokumentation anzeigen kann, sowie ein Dateikennwort festzulegen, sodass nur ausgewählte Personen oder Organisationen sie anzeigen können.

Sobald alle erforderlichen Felder wie API-Dokumentationsname und Sprache ausgefüllt wurden, drücken Sie Enter auf Ihrer Tastatur oder die Schaltfläche Speichern.

Anzeigen oder Teilen Ihrer REST-API-Dokumentation

Apidog kompiliert die Details Ihres API-Projekts in eine API-Dokumentation, die über eine Website-URL angezeigt werden kann. Alles, was Sie tun müssen, ist, auf den Link "Link kopieren" unter "Aktionen" zu klicken und die URL in Ihren bevorzugten Browser einzugeben, um Ihre API-Dokumentation anzuzeigen!

Wenn Sie interessiert sind, lesen Sie diesen Artikel über wie man API-Dokumentation mit Apidog generiert.

Fazit

Während Axios diese Vorteile für das Debuggen bietet, ist es wichtig zu beachten, dass das Debuggen von SOAP-APIs auch das Verständnis des SOAP-Protokolls, der XML-Struktur und der spezifischen Anforderungen des SOAP-Dienstes beinhalten kann. Darüber hinaus können dedizierte API-Testtools wie Apidog möglicherweise spezialisiertere Unterstützung für die Arbeit mit SOAP-spezifischen Funktionen bieten.