Arbeiten mit Postman

Postman ist ein leistungsstarkes Tool zur Entwicklung, Dokumentation und Überprüfung von APIs. Es ermöglicht Ihnen, HTTP-Anfragen zu senden, Antworten zu analysieren und API-Workflows zu automatisieren – alles in einer benutzerfreundlichen grafischen Oberfläche.

Warum Postman?

Als Entwickler im MERN-Stack werden Sie regelmässig mit APIs arbeiten. Postman bietet folgende Vorteile:

• Einfaches Testen von APIs ohne Code zu schreiben
• Visualisierung von Antworten in verschiedenen Formaten (JSON, XML, HTML)
• Speichern von Anfragen für spätere Verwendung
• Organisieren in Kollektionen für strukturierte Workflows
• Automatisiertes Testen mit Testskripten
• Umgebungsvariablen für verschiedene Entwicklungsstadien

Einrichtung von Postman

Schritt 1: Installation

1. Besuchen Sie die offizielle Postman-Website: https://www.postman.com/downloads/
2. Laden Sie die Version für Ihr Betriebssystem herunter (Windows, macOS oder Linux)
3. Führen Sie die Installationsdatei aus und folgen Sie den Anweisungen

Schritt 2: Anmeldung (optional)

Sie können Postman ohne Anmeldung nutzen, dafür auf den Button “Skip” klicken.

Schritt 3: Erste Schritte in der Oberfläche

Die Hauptbereiche der Postman-Oberfläche:

1. Sidebar: Navigation durch Kollektionen, Umgebungen und API-Netzwerke
2. Request-Bereich: Hier erstellen Sie Ihre HTTP-Anfragen
3. Response-Bereich: Hier sehen Sie die Antworten auf Ihre Anfragen

Erste Anfrage mit Postman

Eine GET-Anfrage senden

1. Klicken Sie auf das ”+” Symbol oder “New”, um eine neue Anfrage zu erstellen

2. Wählen Sie “GET” aus dem Dropdown-Menü

3. Geben Sie eine URL ein (z.B. https://jsonplaceholder.typicode.com/posts/1)

4. Klicken Sie auf “Send”

5. Betrachten Sie die Antwort im unteren Bereich:

   • Statuscode (z.B. 200 OK)
   • Response-Zeit
   • Antwortgrösse
   • Body der Antwort (typischerweise JSON für APIs)

Eine POST-Anfrage senden

1. Ändern Sie die Methode zu “POST” im Dropdown-Menü

2. Geben Sie eine URL ein (z.B. https://jsonplaceholder.typicode.com/posts)

3. Wechseln Sie zum “Body”-Tab

4. Wählen Sie “raw” und dann “JSON” aus dem Dropdown-Menü

5. Geben Sie Ihren JSON-Body ein, zum Beispiel:

   {
   "title": "Mein neuer Beitrag",
   "body": "Dies ist der Inhalt des Beitrags",
   "userId": 1
   }

6. Klicken Sie auf “Send”

7. Analysieren Sie die Antwort (typischerweise Statuscode 201 Created für erfolgreiche Erstellungen)

Wichtige Funktionen in Postman

Request-Parameter

• Query-Parameter: Fügen Sie URL-Parameter über den “Params”-Tab hinzu
• Path-Parameter: Teil der URL, z.B. /users/{userId}
• Headers: Fügen Sie HTTP-Headers über den “Headers”-Tab hinzu
• Body: Senden Sie Daten im Body (für POST, PUT, PATCH)
• Auth: Konfigurieren Sie verschiedene Authentifizierungsmethoden

Collections

Collections helfen, Anfragen zu organisieren:

1. Klicken Sie auf “New” und wählen Sie “Collection”
2. Geben Sie einen Namen für Ihre Collection ein
3. Speichern Sie Anfragen in dieser Collection, indem Sie auf “Save” klicken und die Collection auswählen
4. Zugriff auf gespeicherte Anfragen über die Sidebar

Übung: API-Interaktion mit Postman

Aufgabe: JSONPlaceholder API erkunden

In dieser Übung werden Sie die JSONPlaceholder API mit Postman erkunden, eine Sammlung erstellen und verschiedene HTTP-Methoden ausprobieren.

Schritt 1: Collection erstellen

1. Erstellen Sie eine neue Collection namens “JSONPlaceholder API”
2. Erstellen Sie einen Ordner innerhalb der Collection namens “Posts”

Schritt 2: GET-Anfragen erstellen und speichern

1. Erstellen Sie eine neue GET-Anfrage an https://jsonplaceholder.typicode.com/posts

   • Benennen Sie sie “Get All Posts”
   • Speichern Sie sie im “Posts”-Ordner

2. Erstellen Sie eine weitere GET-Anfrage an https://jsonplaceholder.typicode.com/posts/1

   • Benennen Sie sie “Get Single Post”
   • Speichern Sie sie im “Posts”-Ordner

Schritt 3: POST-Anfrage erstellen

1. Erstellen Sie eine POST-Anfrage an https://jsonplaceholder.typicode.com/posts
2. Fügen Sie im Body (raw, JSON) folgende Daten ein:

{
  "title": "Mein Testbeitrag",
  "body": "Dies ist ein Testbeitrag, erstellt mit Postman",
  "userId": 1
}

3. Benennen Sie sie “Create Post” und speichern Sie sie im “Posts”-Ordner

Schritt 4: PUT und DELETE hinzufügen

1. Erstellen Sie eine PUT-Anfrage an https://jsonplaceholder.typicode.com/posts/1

• Fügen Sie im Body ähnliche JSON-Daten wie bei POST ein
• Benennen Sie sie “Update Post”

2. Erstellen Sie eine DELETE-Anfrage an https://jsonplaceholder.typicode.com/posts/1

• Benennen Sie sie “Delete Post”

Schritt 5: Anfragen ausführen und analysieren

1. Führen Sie jede Anfrage aus und notieren Sie:

• Den Statuscode
• Die Response-Zeit
• Die zurückgegebenen Daten

2. Bei der POST-Anfrage: Welche ID wurde dem neu erstellten Beitrag zugewiesen?
3. Für die PUT-Anfrage: Vergleichen Sie die zurückgegebenen Daten mit den gesendeten Daten
4. Für die DELETE-Anfrage: Was erhalten Sie als Antwort?

Bonus: URL-Parameter verwenden

1. Erstellen Sie eine neue GET-Anfrage an https://jsonplaceholder.typicode.com/posts
2. Fügen Sie über den “Params”-Tab einen Query-Parameter hinzu:

• Key: userId
• Value: 1

3. Benennen Sie die Anfrage “Get Posts by User” und speichern Sie sie
4. Wie unterscheidet sich das Ergebnis von “Get All Posts”?

Zusammenfassung

Postman ist ein unverzichtbares Werkzeug für moderne Webentwickler:

• Es erleichtert das Testen und Debuggen von APIs
• Sie können Anfragen speichern, organisieren und wiederverwenden
• Es bietet detaillierte Einblicke in Antworten und Statuscodes
• Die Benutzung von Collections ermöglicht strukturiertes Arbeiten

Mit Postman können Sie APIs effizienter entwickeln und testen, bevor Sie sie in Ihren MERN-Stack-Anwendungen implementieren. Im nächsten Kapitel werden wir uns genauer mit HTTP-Statuscodes befassen und wie Sie diese für eine effektive Fehlerbehandlung nutzen können.