Das Postman-API-Monitoring einrichten

Uptrends bietet das Postman-API-Prüfobjekt, mit dem du deine bestehenden Postman-Workspace-Sammlungen im Uptrends Checkpoint-Netzwerk direkt ausführen kannst. Du kannst ganz einfach Postman-Skripte planen und ausführen, die Performance deiner APIs testen und alles wie bei jedem anderen Prüfobjekt einrichten.

Postman ist ein Standardtool der Branche, das Entwickler nutzen, um API-Tests zu schreiben, zu dokumentieren und auszuführen. Es wird von Millionen genutzt. Mit diesem Tool kannst du HTTP-Methoden (GET, POST, PUT, DELETE, PATCH) testen und Header, Parameter, Variablen und vieles mehr hinzufügen. Du kannst auch mehrere Abfragen, Postman-Sammlungen genannt, zur späteren Nutzung gruppieren und ordnen und sie für andere freigeben. Rufe einfach Postman auf und du kannst deine API-Skripte mit einem Klick ausführen, wenn du deine APIs testen möchtest.

Bei Uptrends musst du Postman nicht aufrufen, um Skripte zu testen. Dein Postman-API-Prüfobjekt erledigt die Arbeit für dich. Das Prüfobjekt nimmt deine Postman-Sammlung an API-Skripten, einschließlich Pre- und Post-Request-Skripte, importiert sie anhand einer API-URL oder aus einer JSON-Datei und führt sie dann auf der ganzen Welt aus, ähnlich wie andere Prüfobjekttypen.

Vorteile des Postman-API-Prüfobjekts

Wenn dein Unternehmen bereits Postman nutzt, setze dieses Prüfobjekt ein und profitiere von den folgenden Vorteilen:

• Automatische Ausführung deiner Skripte: Du kannst deine Postman-Sammlung importieren und sie jede Minute, alle 5 Minuten oder jede Stunde sowie überall auf der Welt ausführen, statt dies manuell anzustoßen. Wir haben über 200 Monitoring Checkpoints, unter denen du wählen und mit denen du deine Skripte testen kannst. Wenn deine Sammlung Variablen wie {{VariableName}} in Abfragen, Skripten oder Umgebungen enthält, erkennt das Prüfobjekt darüber hinaus diese vordefinierten Variablen automatisch und erstellt sie für dich. Diese Variablen werden im Bereich Variablen des Prüfobjekteditors gelistet und du brauchst nur ihren Wert einzugeben. Weitere Informationen findest du unter Postman API-Variablen.

• Keine Vorbereitungszeit: Einfach deine bestehenden Skripte in Uptrends importieren und dein Prüfobjekt ist buchstäblich konfiguriert und kann ausgeführt werden. Es ist nicht notwendig, diese Skripte an Uptrends’ Konventionen anzupassen oder andere Änderungen vorzunehmen.

• Nichts Neues zu lernen: Mit deinen Kenntnissen von Postman wird es dir leichtfallen, dieses Prüfobjekt zu nutzen. Verweise einfach auf deine Postman-Skripte und wir berichten dir blitzschnell von den Ergebnissen.

• Keine Änderungen an deinem aktuellen Workflow: Du kannst einfach mit der Verwaltung deiner Skripte in Postman fortfahren. Denke einfach daran, nach Änderungen deine Sammlung nach einer Änderung erneut in Uptrends abzurufen – dann ist alles auf dem neuesten Stand.

Ein Postman-API-Prüfobjekt einrichten

Es gibt zwei Möglichkeiten, ein Postman-API-Prüfobjekt einzurichten: Importieren von Postman-Skripten aus einer JSON-Datei oder Importieren von Postman-Skripten anhand einer API-URL.

Aus einer JSON-Datei importieren

Diese Option ermöglicht dir, gleichzeitig ein Back-up deiner Postman-Dateien und das Importieren von Änderungen von Postman nach Uptrends.

Um ein Prüfobjekt anhand eines JSON-Dateiimports einzurichten:

1. Gehe im Menü zu API-Prüfobjekte einrichten (+).

2. Wähle die Option Postman-API.

3. Konfiguriere die Prüfobjekteinstellungen gemäß deinen Monitoring-Anforderungen.

4. Wähle auf dem Tab Postman-Sammlung
   Aus einer JSON-Datei importieren. Um zu erfahren, wie du eine JSON-Datei aus Postman zu exportierst, lies Export collections from Postman.

5. Klicke auf die Schaltfläche Choose File und importiere die JSON-Datei.

Nach dem Import wird der Abschnitt Sammlungsdetails automatisch ausgefüllt und zeigt dieselben Informationen wie in Postman. Daten wie der Sammlungsname, die ID und Abfragen sind nun zu sehen.

Wenn deine Sammlung Variablen wie {{VariableName}} in Abfragen, Skripten oder Umgebungen enthält, erkennt das Prüfobjekt diese vordefinierten Variablen automatisch und erstellt sie für dich. Mehr erfährst du unter Postman API-Variablen.

6. Klicke auf Speichern, um alle Änderungen zu bestätigen.

Dein Prüfobjekt ist nun eingerichtet. Verwende die Schaltfläche Jetzt testen im Einrichtungsfenster, um es zu testen und die Prüfobjektergebnisse anzuzeigen.

Anhand einer API-URL importieren

Diese Option erlaubt dir, Änderungen von Postman nach Uptrends anhand einer API-URL zu importieren. Dies ist beim Live-Testen nützlich. Mit einem Klick wird deine Sammlung aktualisiert und es spart zudem Speicherplatz.

Um ein Prüfobjekt anhand der API-URL der Postman-Sammlung zu erstellen:

1. Gehe im Menü zu API-Prüfobjekte einrichten (+).

2. Wähle die Option Postman-API.

3. Konfiguriere die Prüfobjekteinstellungen gemäß deinen Monitoring-Anforderungen.

4. Wähle auf dem Tab Postman-Sammlung
   Über API-URL importieren.

5. Füge die Postman-API-URL in das leere Textfeld ein. Um zu erfahren, wo du die Postman-API-URL findest, lies Share using the Postman API.

6. Klicke auf SAMMLUNG ABRUFEN, um die Daten von der URL abzufragen.

Nach dem Import wird der Abschnitt Sammlungsdetails automatisch ausgefüllt und zeigt dieselben Informationen wie in Postman. Daten wie der Sammlungsname, die ID und Abfragen sind nun zu sehen.

Wenn deine Sammlung Variablen wie {{VariableName}} in Abfragen, Skripten oder Umgebungen enthält, erkennt das Prüfobjekt diese vordefinierten Variablen automatisch und erstellt sie für dich. Mehr erfährst du unter Postman API-Variablen.

7. Klicke auf Speichern, um alle Änderungen zu bestätigen.

Dein Prüfobjekt ist nun eingerichtet. Verwende die Schaltfläche Jetzt testen im Einrichtungsfenster, um es zu testen und die Prüfobjektergebnisse anzuzeigen.

Weitere Informationen findest du in der Postman-Dokumentation.

Ergebnisse überwachen

Die Ergebnisse des Postman-API-Prüfobjekts ähneln den Ergebnissen des Multi-Step API Monitorings. Im Bereich Kontrolldetails spiegelt jeder Schritt jede Abfrage wider, die in der Postman-Sammlung enthalten ist – mit den folgenden Elementen:

• Schrittdauer: die Dauer (in Millisekunden), in der der Schritt ausgeführt wird
• Schritt-Assertions: die tatsächlichen Testergebnisse basierend auf den Vor-Anfrage- und Nach-Antwort-Skripten parallel zu den Postman-Testergebnissen. Du kannst die Gesamtzahl der bestätigten und fehlgeschlagenen Assertions sehen. Bestätigte Ergebnisse sind mit grünem Häkchen markiert, fehlgeschlagene Ergebnisse sind mit einem roten X markiert.
• Es werden auch weitere Daten wie Request Header, Request-Inhalte und Response Header auf gleiche Weise wie in Postman angezeigt. Beispielsweise Cache-Control, Content-Length, Server, Date usw.

Credits

Wie Multi-Step API-Prüfobjekte sind für das Postman-API-Prüfobjekt API-Credits erforderlich. Jede Abfrage, die in der importierten Sammlung enthalten ist, verbraucht einen Credit.