APIs testen mit Postman #1: Überblick und Einstieg

Postman ist ein mächtiger API-Client. Er ermöglicht es, HTTP-Requests abzuschicken und APIs zu testen. Hierfür stellt Postman eine Sandbox bereit, in der Du mittels JavaScript Requests vorbereiten und Tests automatisieren kannst.

Ich nutze Postman in meiner täglichen Arbeit, um die Webservices meines Backend-Teams zu testen. In diesem Beitrag möchte ich anhand einer öffentlichen API zeigen, wie Du Postman einrichtest und Deinen ersten Request abschickst.

Postman installieren oder für den Web-Client registrieren

Zunächst musst Du Postman herunterladen oder Dir einen Account anlegen, um die Web-Version zu nutzen. Ich selbst verwende für diesen Beitrag den Web-Client, der sich äußerlich nicht von der lokal installierten Software unterscheidet.

Hast Du Postman installiert und startest es, müsste es ungefähr so aussehen:

Eine Collection anlegen

Um mehrere Services oder Projekte voneinander zu trennen, arbeitet Postman mit Collections. Die Collection ist die oberste Ebene einer Menge zusammengehöriger Requests. Innerhalb der Collection kannst Du Ordner als weitere Strukturelemente anlegen. Doch darum brauchen wir uns zu diesem Zeitpunkt nicht kümmern.

Eine Collection legst Du folgendermaßen an:

1. Öffne im linken Menü den Reiter „Collections“.
2. Klicke auf das kleine Plus-Symbol neben Collections.
3. Benenne die Collection abschließend noch „Agify“. Drücke dazu CMD+E bzw. öffne das Kontext-Menü neben dem Collection-Namen und klicke dort auf „Rename“.

GET-Request mit Postman anlegen und abschicken

Für dieses Beispiel verwenden wir die kostenlose und frei zugängliche API Agify. Im Wesentlichen nimmt die API einen Namen entgegen und schickt ein Alter zurück, das eine Person mit diesem Namen mit einer gewissen Wahrscheinlichkeit hat. Wenn Du es genauer wissen möchtest, stöbere einfach ein wenig in der Dokumentation der API.

Zurück zum How-To – folge diesen Schritten, um einen Request anzulegen und abzuschicken:

1. Wenn Du die zuvor angelegte Collection aufklappst, kannst Du darin einen Request erstellen. Ist die Collection noch leer, klicke auf den Link „Add a request“. Alternativ öffne erneut das Kontext-Menü neben dem Collection-Namen und klicke auf „Add Request“.
2. Gib dem Request einen sprechenden Namen, zum Beispiel: Get predicted age of name
3. Falls nicht bereits ausgewählt, setze die Request-Methode auf GET und füge daneben die URL „https://api.agify.io?name=michael“ in die Adressleiste ein.
4. Um den Request abzuschicken, klicke auf „Send“ – fertig.

Sobald Du den Request abschickst, bekommst Du eine entsprechende Antwort von der API. Hast Du alles richtig gemacht und ist der Server erreichbar, solltest Du einen Status-Code 200 und einen entsprechenden Body mit Name, Alter und Anzahl zurückbekommen.

Ausblick: Mit Umgebungsvariablen dynamische Requests für verschiedene Hosts anlegen

Im nächsten Beitrag zum Thema APIs testen mit Postman zeige ich Dir, wie Du Umgebungen in Postman anlegst und mit Hilfe von Umgebungsvariablen einen Request an verschiedene Hosts schicken kannst.