Das Testen eines API-Endpunkts ist einmalig unkompliziert. Sie senden eine Anfrage, überprüfen die Antwort und bestätigen, dass alles wie erwartet funktioniert. Die eigentliche Herausforderung beginnt, wenn Sie denselben Test gegen Dutzende – oder sogar Hunderte – verschiedener Datensätze ausführen müssen. Das manuelle Aktualisieren von Parametern und das wiederholte Senden von Anfragen ist nicht nur zeitaufwendig, sondern auch fehleranfällig und unmöglich zu skalieren.
Hier kommt das datengesteuerte API-Testen ins Spiel. Anstatt Anfragen manuell neu zu schreiben oder erneut zu senden, definieren Sie einen einzigen Testfall und führen ihn automatisch mit mehreren Sätzen von Eingabedaten aus. Das Ergebnis ist eine breitere Abdeckung, höhere Genauigkeit und ein weitaus geringerer manueller Aufwand.
Um dies effizient zu tun, benötigen Sie das richtige Tool. Apidog zeichnet sich durch die native Unterstützung datengesteuerter Tests mit CSV- und JSON-Dateien aus. Als All-in-One-Plattform für API-Entwicklung und -Tests können Sie mit Apidog externe Datendateien an ein Testszenario binden und dieses wiederholt ausführen, wobei jede Antwort automatisch validiert wird.
Egal, ob Sie Anmeldeabläufe mit verschiedenen Benutzern, Such-APIs mit unterschiedlichen Abfragen oder die Ressourcenerstellung mit mehreren Parameterkombinationen testen, Apidog eliminiert die sich wiederholende Arbeit und hilft Ihnen, zuverlässige, umfassende API-Tests in einem Bruchteil der Zeit zu erreichen.
Nun, lassen Sie uns in eine vollständige Schritt-für-Schritt-Anleitung eintauchen, um datengesteuerte API-Tests mit Apidog unter Verwendung von CSV und JSON zu meistern.
Schritt-für-Schritt-Anleitung für datengesteuerte API-Tests mit CSV und JSON
Gehen wir den gesamten Prozess, von der Einrichtung bis zur Ausführung, anhand eines konkreten Beispiels durch. Wir werden einen API-Endpunkt für die Benutzerregistrierung testen.
Schritt 1: Definieren Sie Ihre grundlegende API-Anfrage
Zuerst erstellen Sie die API-Anfrage, die als Ihre Testvorlage dienen wird.
- Erstellen Sie in Apidog eine neue Anfrage an Ihren Benutzerregistrierungs-Endpunkt (z. B.
POST /api/v1/users). - Richten Sie die Header ein (z. B.
Content-Type: application/json). - Erstellen Sie im Tab Body Ihre JSON-Payload. Anstatt Werte fest zu codieren, verwenden Sie die dynamische Variablensyntax
{{}}von Apidog, um Platzhalter zu erstellen.
{
"username": "{{username}}",
"email": "{{email}}",
"password": "{{password}}",
"role": "{{role}}"
}
Beachten Sie die Platzhalter: {{username}}, {{email}} usw. Apidog wird diese während der Ausführung durch tatsächliche Werte aus Ihrer Datendatei ersetzen.
Schritt 2: Erstellen Sie Ihre Testdatendatei (CSV oder JSON)
Erstellen Sie nun die externe Datei, die Daten in Ihre Platzhalter einspeist.
Option A: Verwendung einer CSV-Datei
CSV ist perfekt für tabellarische Daten. Erstellen Sie eine Datei user_data.csv:
username,email,password,role,expected_status
john_doe,john@example.com,SecurePass123!,user,201
jane_smith,jane@example.com,AnotherPass456!,admin,201
bad_user,not-an-email,short,user,400
duplicate_user,john@example.com,SomePass789!,user,409- Die erste Zeile definiert die Variablennamen, die Ihren Platzhaltern (
username,emailusw.) entsprechen, plus einen zusätzlichenexpected_statuszur Validierung. - Jede nachfolgende Zeile ist ein Testfall mit den Daten für diesen Durchlauf.
Option B: Verwendung einer JSON-Datei
JSON ist ideal für verschachtelte oder komplexere Datenstrukturen. Erstellen Sie eine Datei user_data.json:
[
{
"username": "john_doe",
"email": "john@example.com",
"password": "SecurePass123!",
"role": "user",
"expected_status": 201
},
{
"username": "jane_smith",
"email": "jane@example.com",
"password": "AnotherPass456!",
"role": "admin",
"expected_status": 201
},
{
"username": "bad_user",
"email": "not-an-email",
"password": "short",
"role": "user",
"expected_status": 400
}
]
Schritt 3: Konfigurieren Sie den datengesteuerten Test in Apidog
Hier kommt der integrierte Workflow von Apidog zur Geltung.
- Gehen Sie zum Tab "Test" in Ihrem Dashboard (oder erstellen Sie einen neuen Testfall in einer Testsuite).
2. Klicken Sie, um einen neuen Testschritt hinzuzufügen, und wählen Sie Ihre Anfrage POST /api/v1/users.
3. Testdaten hochladen: Klicken Sie auf "Testdaten" > "+Neu", um Ihre Datei user_data.csv oder user_data.json hochzuladen. Apidog wird sie analysieren und Ihnen eine Vorschau der Datenzeilen anzeigen.
4. Variablen zuordnen (falls erforderlich): Apidog ordnet die Spaltennamen (CSV) oder Eigenschaftsschlüssel (JSON) automatisch den {{variable}}-Platzhaltern in Ihrer Anfrage zu. Überprüfen Sie, ob die Zuordnung korrekt ist.
Schritt 4: Schreiben Sie Zusicherungen unter Verwendung Ihrer Datenvariablen
Die wahre Stärke liegt in der Validierung verschiedener erwarteter Ergebnisse basierend auf Ihren Eingabedaten. Im Tab Test schreiben Sie Zusicherungen (auch "Asserts" oder "Checks" genannt).
Entscheidend ist, dass Sie in Ihren Zusicherungen dieselben Datenvariablen aus Ihrer Datei referenzieren können.
Fügen Sie zum Beispiel eine Zusicherung für den Antwortstatuscode hinzu:
- Erwarteter Wert:
{{expected_status}}
Dies bedeutet: "Für den ersten Testlauf (john_doe) soll der Statuscode 201 sein. Für den dritten Lauf (bad_user) soll er 400 sein." Die Zusicherung ändert sich dynamisch mit jeder Iteration.
Sie können komplexere Zusicherungen mit JavaScript im Skript-Bereich von Apidog hinzufügen:
// Beispiel: Validieren des Antwortkörpers für eine erfolgreiche Erstellung
pm.test("Status code is " + pm.variables.get("expected_status"), function () {
pm.response.to.have.status(pm.variables.get("expected_status"));
});
// Nur prüfen, ob eine Benutzer-ID vorhanden ist, wenn wir eine erfolgreiche Erstellung erwarten
if (pm.variables.get("expected_status") === 201) {
pm.test("Response has user ID", function () {
var jsonData = pm.response.json();
pm.expect(jsonData.id).to.be.a('number');
pm.expect(jsonData.username).to.eql(pm.variables.get("username"));
});
}
Schritt 5: Führen Sie den Test aus und analysieren Sie die Ergebnisse
Klicken Sie auf die Schaltfläche Ausführen. Apidog führt Ihren einzelnen Testschritt mehrmals aus, einmal für jede Zeile in Ihrer Datendatei.
Der Bericht ist der Ort, an dem alles zusammenläuft:
Apidog präsentiert einen klaren, aggregierten Bericht, der Folgendes zeigt:
- Gesamtzahl der Iterationen: (z. B. "4/4 bestanden")
- Eine Aufschlüsselung für jede Datenzeile: Sie können erweitern, um die exakte gesendete Anfrage (mit den tatsächlich ersetzten Werten) und die empfangene Antwort für diese spezifische Iteration zu sehen.
- Alle Fehler werden auf die spezifische Datenzeile genau lokalisiert, die das Problem verursacht hat. Ist
duplicate_userfehlgeschlagen, weil der Status nicht409war? Sie sehen es sofort.
Dies macht das Debugging unglaublich effizient. Sie müssen nicht raten, welcher Testfall fehlgeschlagen ist; Sie wissen, dass es die Iteration mit dem spezifischen Datensatz {"username": "duplicate_user", ...} war.
Best Practices für datengesteuerte API-Tests
- Umgebungsspezifische Daten: Kombinieren Sie datengesteuerte Tests mit den Umgebungen von Apidog. Sie könnten eine
base_url-Variable in Ihrer Umgebung haben, die sich von Staging zu Produktion ändert, während Ihre CSV-Datei die Testfälle enthält, die für beide anwendbar sind. - Wiederverwendbare Testdaten: Speichern Sie Ihre CSV-/JSON-Dateien an einem zentralen Ort innerhalb Ihres Apidog-Projekts. Mehrere Testsuiten können dieselbe Datendatei referenzieren, um Konsistenz zu gewährleisten.
- Datendateien programmgesteuert generieren: Verwenden Sie für komplexe Szenarien ein Skript (Python, Node.js), um Ihre
test_data.csv-Datei zu generieren. Dies ist hervorragend geeignet, um mit Zufallsdaten oder einer großen Bandbreite von Werten zu testen (z. B. das Testen der Paginierung mit 100 verschiedenenpage- undlimit-Kombinationen). - Test-Setup/Cleanup: Verwenden Sie Apidogs Pre-Request-Skripte und Test-Teardown-Funktionen in Verbindung mit datengesteuerten Tests. Zum Beispiel könnten Sie vor jeder Iteration eines
DELETE-Tests ein Pre-Request-Skript verwenden, um die zu löschende Ressource zu erstellen.
Fazit: Transformieren Sie Ihren API-Test-Workflow
Datengesteuerte Tests in Apidog mit CSV-/JSON-Dateien führen Sie von der manuellen, sich wiederholenden Überprüfung zu einer automatisierten, umfassenden Validierung. Es verkörpert das Kernprinzip guter Tests: Gründlichkeit, ohne die Effizienz zu opfern.
Indem Sie Ihre Testdaten externalisieren, erstellen Sie ein lebendiges Dokument von Testszenarien, das für jedes Mitglied Ihres Teams leicht zu lesen, zu aktualisieren und zu verstehen ist. Die nahtlose Integration dieser Methodik in Apidog bedeutet keine komplexe Einrichtung – nur einen unkomplizierten Weg zu zuverlässigeren APIs.
Hören Sie auf, APIs Fall für Fall zu testen. Laden Sie Apidog noch heute kostenlos herunter, importieren Sie Ihre erste CSV-Datei und erleben Sie, wie leistungsfähig und effizient API-Tests wirklich sein können.