Erste Schritte bei der Verwendung von Postman mit der Discourse API

[supermathie (Michael Brown)]

Zusammenfassung

Postman ist eine Möglichkeit, einfach Anfragen an eine API zu erstellen und zu testen.

Konfiguration mit Discourse

1. Klicken Sie nach dem Öffnen von Postman auf Arbeitsbereich erstellen:

   

2. Wählen Sie Leerer Arbeitsbereich und klicken Sie auf Weiter.

3. Geben Sie als Titel Discourse API ein und wählen Sie Erstellen:

   

4. Klicken Sie auf Sammlungen:
   

   

5. Klicken Sie auf Importieren:
   

   

6. Fügen Sie https://docs.discourse.org/openapi.json ein (dies ist die „Download“-URL, die auf docs.discourse.org angezeigt wird):
   

   

7. Wählen Sie als Importart Postman Collection:
   

   

Neue Umgebung erstellen

1. Klicken Sie auf Umgebungen und Umgebung erstellen. Hier werden Variablen gespeichert, die spezifisch für die Instanz sind, die Sie testen. Für dieses Beispiel verwenden wir try.discourse.org.

   • Fügen Sie eine neue Variable hinzu: defaultHost mit dem Wert try.discourse.org:
   • Wählen Sie die Umgebung try.discourse.org aus dem Dropdown-Menü ⑤ Umgebung aus
   

Hallo Welt!

Lassen Sie uns eine Anfrage ausprobieren!

1. Wählen Sie Sammlungen → categories.json → Ruft eine Liste von Kategorien ab und klicken Sie auf Senden. Sie sollten das Ergebnis sehen:
   
   

Authentifizierung zu Anfragen hinzufügen

Um die API mit API-Schlüssel-Authentifizierung zu verwenden:

1. Fügen Sie die folgenden Variablen zu dieser oder einer neuen Umgebung hinzu:

   • api-username
   • api-key
   
   
   (ihre Werte müssen natürlich für die von Ihnen abgefragte Website gültig sein)

2. Fügen Sie der Sammlung ein Skript hinzu
   Wählen Sie Sammlungen → Discourse API Documentation → Skripte → Vorab-Anfrage und fügen Sie Folgendes ein:

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })