APIs testen mit Postman #2: Umgebungsvariablen verstehen und anwenden

Im ersten Teil dieses Postman-Tutorials habe ich Dir gezeigt, wie Du Deinen ersten GET-Request in Postman anlegst und abschickst. Dabei habe ich die vollständige URL des Requests als statischen Link angelegt. Typischerweise entwickelst Du in der Softwareentwicklung zunächst lokal, testest anschließend auf einer ersten Team- bzw. Integrationsumgebung und lässt die Software schlussendlich auf einer Produktionsumgebung laufen. Um in diesen Fällen Requests nicht mit jeweils einem anderen Host duplizieren zu müssen, kannst Du in Postman Umgebungsvariablen erstellen. Diese ermöglichen es, den Host – sowie andere Parameter – dynamisch anzulegen.

Umgebungsvariablen in Postman anlegen

Etwas unscheinbar versteckt sich in der rechten oberen Ecke von Postman ein Dropdown, das initial „No Environment“ anzeigt. Öffnest Du das Dropdown, kannst Du nichts anderes auswählen. Lass uns das ändern!

Ausgewählte Umgebung in Postman
  • Klicke auf „New“ und wähle „Environment“ aus.
  • Bearbeite den Namen der Umgebung, zum Beispiel in „Production“.
  • In der Tabelle kannst Du nun Umgebungsvariablen anlegen. Vergib den Variablennamen in der Spalte „Variable“ – für dieses Beispiel erstellen wir die Variable „host“. Diesen wirst Du später als Platzhalter in Deine URL schreiben.
  • In die zweite Spalte schreibst Du den initialen Wert Deiner Variable – für den Host also den Hostnamen „api.agify.io“. Der Wert in „Initial Value“ bleibt dort fest gespeichert, während „Current Value“ der Wert ist, der zur Laufzeit eingesetzt wird. Zu Beginn braucht Dich das nicht interessieren, da standardmäßig der initiale Wert in „Current Value“ geschrieben wird.
  • Speichere Deine Änderungen – fertig! Du hast Deine erste Umgebungsvariable angelegt.

Hostnamen mit Umgebungsvariable in Postman dynamisch gestalten

Um die soeben angelegte Umgebungsvariable zu nutzen, fehlen lediglich zwei Schritte:

  • Wähle „Production“ in dem Dropdown oben rechts als Umgebung aus.
  • Ersetze den Hostnamen „api.agify.io“ durch Deine Variable umgeben von zwei geschweiften Klammern: {{host}}.
Umgebungsvariable in Postman

Hast Du alles richtig gemacht, erscheint die aufgelöste Variable in einem Popup, wenn Du mit der Maus darüber hoverst. Falls die Variable rot gefärbt ist und beim Darüberhovern ein Fehler auftaucht, hast Du einen Fehler gemacht. Typischerweise stimmt entweder der Variablenname nicht mit dem zuvor angelegten überein oder es ist keine bzw. die falsche Umgebung ausgewählt.

Weitere Anwendungsmöglichkeiten von Umgebungsvariablen

Mit Umgebungsvariablen kannst Du alle Parameter dynamisch gestalten, deren Wert sich abhängig von der Umgebung unterscheidet. Typische Beispiele sind:

  • Credentials (z. B. client id und client secret)
  • Umgebungsspezifische Testdaten
  • Protokoll – möglicherweise nutzen Deine Testumgebung kein SSL und das Protokoll ist zunächst http und erst ab einer bestimmten Umgebung https

Fazit und Ausblick

In unserem einfachen Beispiel profitierst Du noch nicht von dem Platzhalter anstelle eines statischen Hostnamen. Würde es sich hierbei allerdings um ein Entwicklungsprojekt handeln, könntest Du weitere Umgebungen anlegen. Diese wären beispielsweise „local“, „team“ und „integration“. In jeder Umgebung könntest Du jeweils den gleichen Variablennamen „host“ mit einem anderen Hostnamen belegen:

  • Umgebung „local“:
    • Variable: „host“
    • Initial Value: „localhost“
  • Umgebung „team“:
    • Variable: „host“
    • Initial Value: „team-01.agify.io“
  • usw.

Im nächsten Teil dieser Reihe beschäftige ich mich mit automatisierten Tests in Postman.


Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.