API Response Test mit Postman

• Aufbau von RestAPI Requests und Responses
• Überprüfen von Werten im JSON
• Werte als Variable weiterverwenden für den API Response Test mit Postman
• Fazit zum API Response Test mit Postman

Wir haben die Nutztung von Postman als automatisches API Monitoring in diesem Artikel ausführlich beschrieben. Nun zeigen wir dir, wie du die API Returns von deinem Backend Server genauer unter die Lupe nehmen und testen kannst (API Response Test mit Postman).

Aufbau von RestAPI Requests und Responses

RestAPI Requests sind HTTP Requests, die mittels Get, Post, Update und dergleichen an deinen Backend-Server geschickt werden. Idealerweise hast du dein Backend Service so konfiguriert, dass die nützlichsten Informationen in der Antwort deines API-Servers verpackt werden.

Als Beispiel der Return, nachdem wir über RestAPI einen Linux-Server auf Xelon erstellen:

Als allererstes zu beachten gilt es oben rechts den Status-Code. “200” bedeutet eine erfolgreiche Verarbeitung des API Requests. Die interessantesten Informationen im Body sicherlich die “localdmid” (bei Xelon die Hauptidentifikation eines Servers), sowie beispielsweise auch die IP-Adresse ganz unten (unkenntlich gemacht).

Überprüfen von Werten im JSON

Ich kann in Postman nun definieren, anhand von welchen Informationen erkannt wird, ob ein Request erfolgreich war. In unserem Fall prüfen wir, ob die localvmid existiert:

pm.test("Check if localvmid exists", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.device.localvmid).to.be.a("string");
});

Der Befehl durchsucht die JSON-Struktur im Body nach dem localvmid-Wert innerhalb von “Device”. Erwartet wird ein String. Sollte die Antwort kein String beinhalten, schlägt der Test fehl und alarmiert über das Postman Monitoring das Developer-Team.

Werte als Variable weiterverwenden für den API Response Test mit Postman

Falls eine Collection beispielsweise für ein Monitoring verwendet wird, ist es möglich, dass gewisse JSON Returns in einem der darauffolgenden API Requests wieder verwendet werden müssen. Wenn wir also beispielsweise einen Server erstellen und danach in einem weiteren Call den Serverstatus prüfen möchten, brauchen wir diese ID. Wir können nun die localvmid sehr einfach aus dem Return auslesen und als Variable speichern:

var jsonData = JSON.parse(responseBody);
pm.environment.set("LOCALVMID", jsonData.device.localvmid);
console.log(pm.environment.get("LOCALVMID"))

Die localvmid wird ausgelesen, und in der Environment Variablen “localvmid” gespeichert. Diese Variable kann ich nun im nächsten Request verwenden.

Der komplette “Tests” Bereich sieht nun folgendermassen aus: