Talend API Tester: API Tests einfach durchführen

Talend API Tester ist eine Chrome-Erweiterung zum Senden von HTTP-Anfragen und zum Überprüfen von Antworten, ohne den Browser verlassen zu müssen. Es war früher als Restlet Client bekannt, und viele Entwickler behalten es immer noch für schnelle Überprüfungen installiert, da über die Erweiterung selbst nichts heruntergeladen werden muss. Es verarbeitet REST-APIs, unterstützt die gängigen HTTP-Methoden und kann Anfragen zu Szenarien verketten.

Dieser Leitfaden zeigt, wie man Talend API Tester für echte Testarbeiten verwendet. Sie werden es installieren, Ihre erste Anfrage senden, Anfragen in Projekten und Diensten organisieren, ein Szenario erstellen, das mehrere Anfragen nacheinander ausführt, und Zusicherungen hinzufügen, damit das Tool die Antworten für Sie überprüft, anstatt dass Sie sie manuell durchsehen. Die Beispiele verwenden eine öffentliche API, sodass Sie sofort mitmachen können.

Erweiterung installieren und eine Anfrage senden

Talend API Tester befindet sich im Chrome Web Store. Suchen Sie nach „Talend API Tester“ und klicken Sie auf Zu Chrome hinzufügen. Es läuft auch in Chromium-basierten Browsern wie Edge und Brave. Nach der Installation öffnen Sie es über das Erweiterungsmenü oder heften es für den schnellen Zugriff an die Symbolleiste an.

Die Benutzeroberfläche hat eine Seitenleiste links und ein Anfragemodul rechts. Klicken Sie in das Anfragemodul, und Sie sehen ein Dropdown-Menü für die Methode, ein URL-Feld und Registerkarten für Header und Body.

Um eine grundlegende Anfrage zu senden, wählen Sie GET und geben Sie einen echten Endpunkt ein. Der JSONPlaceholder-Dienst eignet sich gut zum Üben:

GET https://jsonplaceholder.typicode.com/users/1

Klicken Sie auf Senden. Die Antwort erscheint darunter mit dem Statuscode, der Antwortzeit, den Headern und dem Body. Talend API Tester formatiert JSON und XML hübsch, sodass eine verschachtelte Antwort ohne zusätzliche Schritte lesbar ist.

Für eine POST ändern Sie die Methode, öffnen Sie den Bereich Body und wählen Sie einen Inhaltstyp. Wählen Sie application/json und geben Sie eine Nutzlast ein:

{
  "name": "Priya Nair",
  "email": "priya.nair@example.com"
}

Fügen Sie Header im Bereich Headers hinzu. Für eine authentifizierte API fügen Sie einen Authorization-Header mit Ihrem Token hinzu. Das Tool verfügt auch über integrierte Authentifizierungshilfen für Basic-, Digest-, OAuth- und Bearer-Schemata, falls Sie den Header nicht manuell setzen möchten.

Anfragen in Projekten und Diensten organisieren

Eine Handvoll loser Anfragen ist in Ordnung für einen schnellen Blick auf eine API. Wenn Sie viele haben, möchten Sie Struktur. Talend API Tester organisiert die Arbeit in Projekten und innerhalb eines Projekts in Diensten.

Erstellen Sie ein Projekt in der Seitenleiste und geben Sie ihm einen klaren Namen wie „Benutzer-API“. Erstellen Sie darin Dienste, die verwandte Endpunkte gruppieren, z. B. einen „Benutzer“-Dienst und einen „Bestellungen“-Dienst. Speichern Sie jede Anfrage im richtigen Dienst. Ein Dienst kann eine Basis-URL enthalten, sodass einzelne Anfragen darunter nur den Pfad benötigen, was die Dinge übersichtlich hält.

Diese Struktur ist aus zwei Gründen wichtig. Erstens macht sie eine große Menge von Anfragen navigierbar, sodass Sie nicht durch Dutzende unbeschrifteter Aufrufe scrollen müssen, um den gewünschten zu finden. Zweitens ist sie die Grundlage für Szenarien, die wir als Nächstes behandeln, da ein Szenario auf gespeicherte Anfragen verweist.

Projekte helfen auch beim Wechseln der Umgebung. Talend API Tester unterstützt Umgebungsvariablen, sodass Sie eine host-Variable definieren können, die Ihre Staging-URL enthält, und diese über jede Anfrage in einem Projekt mit einem Platzhalter referenzieren können. Definieren Sie eine zweite Umgebung mit dem Produktions-Host, wechseln Sie zwischen ihnen, und das gesamte Projekt wird sofort neu ausgerichtet. Dies verhindert, dass Sie URLs manuell bearbeiten und versehentlich eine destruktive Anfrage an den falschen Server senden.

Talend API Tester kann auch bestehende Arbeiten importieren. Es akzeptiert Postman-Sammlungen, Swagger- und OpenAPI-Definitionen sowie HAR-Dateien. Wenn Sie bereits eine API-Spezifikation oder einen Postman-Export haben, importieren Sie diese, anstatt jede Anfrage manuell neu zu erstellen. Für eine strukturierte Denkweise über die Gruppierung von Prüfungen ist der Leitfaden zum API-Testfall-Beispiel ein nützlicher Begleiter.

Ein Szenario erstellen, um Anfragen nacheinander auszuführen

Eine einzelne Anfrage beantwortet eine Frage. Echtes Testen bedeutet meist einen Ablauf: einen Datensatz erstellen, ihn wieder auslesen, aktualisieren, löschen. Talend API Tester bewältigt dies mit Szenarien.

Ein Szenario ist eine geordnete Liste gespeicherter Anfragen. Erstellen Sie eines in der Seitenleiste und fügen Sie dann Anfragen in der Reihenfolge hinzu, in der sie ausgeführt werden sollen. Wenn Sie das Szenario ausführen, feuert das Tool jede Anfrage von oben nach unten ab und zeigt das Ergebnis jedes Schritts an.

Der nützliche Teil ist das Übergeben von Daten zwischen den Schritten. Ein Szenario kann einen Wert aus einer Antwort erfassen und ihn einer späteren Anfrage zuführen. Zum Beispiel gibt eine „Benutzer erstellen“-Anfrage eine neue id im Antwort-Body zurück. Sie extrahieren diese id in eine Variable, und eine spätere „Benutzer abrufen“-Anfrage verwendet die Variable in ihrer URL. So testen Sie zustandsbehaftete Abläufe statt isolierter Aufrufe.

Szenarien unterstützen auch bedingte Logik und Wiederholungen. Sie können basierend auf einer Antwort verzweigen, sodass ein Schritt nur ausgeführt wird, wenn ein vorheriger einen bestimmten Status zurückgegeben hat, und Sie können einen Schritt wiederholen, um einen Endpunkt mehrmals aufzurufen. In Kombination mit der Variablentransformation ermöglicht dies einem einzigen Szenario, eine realistische Sequenz zu modellieren: authentifizieren, einen Datensatz erstellen, bestätigen, dass er korrekt gelesen wird, ihn ändern und dann durch Löschen bereinigen. Das Ausführen dieses Szenarios von Anfang bis Ende ist ein weitaus besseres Signal als das isolierte Ausführen jeder Anfrage. Der Artikel über Testszenario versus Testfall erklärt den Unterschied zwischen einer einzelnen Prüfung und einem mehrstufigen Ablauf, was hier direkt auf Anfragen versus Szenarien zutrifft.

Zusicherungen hinzufügen, damit das Tool die Antworten überprüft

Das Ausführen eines Szenarios zeigt Ihnen, was zurückkam. Zusicherungen lassen das Tool entscheiden, ob das Zurückgekommene korrekt ist, sodass Sie nicht jede Antwort manuell lesen müssen.

Talend API Tester ermöglicht es Ihnen, Zusicherungen an eine Anfrage anzuhängen. Öffnen Sie eine gespeicherte Anfrage und finden Sie den Bereich für Zusicherungen. Sie erstellen Zusicherungen über ein Formular statt durch das Schreiben von Code. Häufige sind:

• Statuscode entspricht einem erwarteten Wert, z. B. 200 oder 201.
• Antwortzeit liegt unter einem Schwellenwert, z. B. 500 Millisekunden.
• Ein Nutzlastfeld stimmt mit einem erwarteten Wert überein, unter Verwendung eines Pfades im JSON-Body.
• Ein Header ist vorhanden oder hat einen bestimmten Wert.

Jede von Ihnen hinzugefügte Zusicherung wird ausgewertet, wenn die Anfrage ausgeführt wird, entweder eigenständig oder als Schritt in einem Szenario. Das Ergebnispanel kennzeichnet jede Zusicherung als bestanden oder fehlgeschlagen. Führen Sie das gesamte Szenario aus, und Sie erhalten ein klares Bestanden oder Fehlgeschlagen für jeden Schritt, was das Szenario zu einer wiederholbaren Regressionstestprüfung macht.

Da die Zusicherungen formularbasiert und nicht codebasiert sind, ist das Tool für Tester zugänglich, die kein JavaScript schreiben. Das ist eine echte Stärke für schnelle, manuelle Überprüfungen. Die Kehrseite ist, dass der Zusicherungs-Wortschatz enger ist als bei einem Skript-basierten Tool. Wenn Sie etwas zusichern müssen, das das Formular nicht ausdrückt, wie z. B. einen berechneten Wert oder eine komplexe Bedingung über mehrere Felder hinweg, werden Sie an die Grenzen stoßen. Für die meisten alltäglichen Überprüfungen reichen ein Statuscode plus ein paar Body-Feld-Zusicherungen aus. Eine Anleitung, was sich zu zusichern lohnt, finden Sie im ausführlicheren Leitfaden zu API-Zusicherungen.

Die Antwort richtig lesen

Ob Sie Zusicherungen hinzufügen oder nicht, Sie sollten wissen, wie man eine Antwort liest. Vier Teile sind wichtig.

1. Statuscode. Dies ist das erste Signal. 2xx bedeutet Erfolg, 4xx bedeutet, dass die Anfrage falsch war, 5xx bedeutet, dass der Server fehlgeschlagen ist. Eine Referenz wie der Leitfaden zu welche HTTP-Statuscodes REST-APIs verwenden sollten hilft Ihnen, die weniger offensichtlichen zu interpretieren.
2. Antwortzeit. Talend API Tester meldet, wie lange die Anfrage gedauert hat. Ein langsamer Endpunkt ist ein Problem, selbst wenn er die richtigen Daten zurückgibt.
3. Header. Header enthalten Content-Type, Caching-Direktiven, Ratenbegrenzungsinformationen und CORS-Details. Sie erklären oft Verhalten, das der Body nicht tut.
4. Body. Die eigentlichen Daten, normalerweise JSON oder XML. Überprüfen Sie, ob die Felder, Typen und Werte dem versprochenen Vertrag entsprechen.

Das Zusammenlesen aller vier teilt Ihnen mit, ob die API intakt ist, nicht nur, ob sie geantwortet hat.

Wenn eine Chrome-Erweiterung nicht ausreicht

Talend API Tester ist bequem und schnell für browserbasierte Prüfungen. Seine Grenzen zeigen sich, wenn die Arbeit wächst. Es ist an Chrome gebunden, kann also nicht headless in einer CI-Pipeline ausgeführt werden. Sein Zusicherungssystem ist solide, aber im Vergleich zu einer vollständigen Testplattform grundlegend. Und es deckt kein API-Design, Mocking oder Dokumentation ab, ist also eher ein Werkzeug unter mehreren als ein einziger Arbeitsbereich.

Apidog ist eine All-in-One-API-Plattform, die diese Lücken füllt. Es ist eine eigenständige Anwendung statt einer Browser-Erweiterung, es importiert Postman-, OpenAPI- und andere Formate genau wie Talend API Tester, und es fügt einen visuellen Zusicherungs-Builder, Mock-Server, automatisierte Testszenarien und generierte Dokumentation in einem Projekt hinzu. Da Spezifikation und Tests eine gemeinsame Quelle der Wahrheit teilen, driften sie nicht auseinander. Sie können Apidog herunterladen und Ihre bestehenden Anfragen importieren, um zu vergleichen. Für einen breiteren Überblick über Optionen ist der Vergleich von kostenlosen Online-API-Testwerkzeugen ein guter Ausgangspunkt.

Talend API Tester bleibt eine gute Wahl für schnelle, In-Browser-Prüfungen. Passen Sie das Werkzeug an die Größe und Phase Ihrer Testarbeit an.

Häufig gestellte Fragen

Ist Talend API Tester dasselbe wie Restlet Client?

Ja. Talend API Tester ist die umbenannte Version des Tools, das früher Restlet Client hieß. Die Funktionalität ist die gleiche Linie: eine Chrome-Erweiterung zum Senden von HTTP-Anfragen, deren Organisation und dem Ausführen von Szenarien mit Zusicherungen.

Ist Talend API Tester kostenlos?

Es gibt eine kostenlose Version im Chrome Web Store, die das Senden von Anfragen, deren Organisation in Projekten und das Erstellen von Szenarien mit Zusicherungen abdeckt. Kostenpflichtige Stufen fügten historisch Teamfunktionen und größere Limits hinzu. Die kostenlose Version reicht für die meisten individuellen Testarbeiten aus.

Kann Talend API Tester Tests in CI/CD ausführen?

Nicht direkt. Es ist eine Chrome-Erweiterung und läuft innerhalb des Browsers, sodass es nicht headless in einer Pipeline ausgeführt werden kann. Für automatisierte Tests, die bei jedem Commit ausgeführt werden, benötigen Sie ein Tool mit einem Kommandozeilen-Runner. Der Leitfaden zum Automatisieren von API-Tests in CI/CD beschreibt, wie eine solche Einrichtung aussieht.

Welche Formate kann Talend API Tester importieren?

Es kann Postman-Sammlungen, Swagger- und OpenAPI-Definitionen sowie HAR-Dateien importieren. Dadurch können Sie bestehende API-Spezifikationen oder Exporte einbringen, anstatt jede Anfrage manuell neu zu erstellen.

Wie unterscheidet sich ein Szenario von einer einzelnen Anfrage?

Eine einzelne Anfrage sendet einen HTTP-Aufruf und zeigt eine Antwort. Ein Szenario ist eine geordnete Liste von Anfragen, die nacheinander ausgeführt werden, und es kann aus einer Antwort erfasste Daten an eine spätere Anfrage weitergeben. Szenarien testen mehrstufige Abläufe, wie z. B. erstellen, dann lesen, dann löschen, während eine einzelne Anfrage einen isolierten Aufruf testet.