5 Minuten - API-Entwicklung mit Postman

In diesem Video erklärt Lucas Nothnagel was Postman ist und wie man es verwenden kann. Dabei geht er auf die Nutzung von Variablen ein, die einem helfen wiederverwendbaren Code zu schreiben, erstellt einfache Request und teilt diese mit seinen Kollegen.

► Lucas Nothnagel Twitter: https://twitter.com/thenothnagel

► Super Duper Developers Club Twitter-Kanal: https://twitter.com/sddevclub

► Super Duper Podcast zum Thema API Testing: https://www.youtube.com/watch?v=4fD-2…

Alles Wichtige zu Postman

Lucas Nothnagel vom Super Duper Developers Club hat sie 5 Minuten Zeit genommen, um Postman vorzustellen. Ein Werkzeug für Webentwickler, mit dem man den kompletten API-Entwicklungszyklus abdecken kann.

Aber was ist der komplette Lebenszyklus einer API? Wir haben mal die wichtigsten Punkte, die man mit Postman abdecken kann, zusammengefasst:

  • Entwicklung: Mit Postman lassen sich alle Arten von HTTP-Requests in einer einfach zu benutzenden Umgebung ausführen und speichern. Alle wichtigen Parameter, wie Header, Body oder HTTP-Methode können gesetzt werden.
    Wir nutzen das Tool während der Entwicklung, indem wir alle Endpunkte unserer Applikation als Request hinterlegen. Dabei legen wir Collections für jedes Thema an (in Symfony meist nach Controller gruppiert). Mittlerweile sind es Hunderte, aber dank der sauberen Struktur in Postman kann man das problemlos pflegen.
  • Deployment: Wir haben vier Umgebungen, in denen die Requests laufen können müssen. Lokal, Dev, Stage und Produktion. Postman bietet dazu Umgebungen und Variablen an. Wir können also Platzhalter in unseren Requests verwenden, die dann je nach Umgebung gefüllt werden. Ein einfaches Beispiel wären Username und Passwort. Das sollte lokal sicherlich anders sein, als im Produktionssystem. Das Ganze ist bei allen ID-basierten sehr nützlich und die Pflege der Variablen wunderbar einfach.
  • Testing: Postman bietet die Möglichkeit, alle Requests kontinuierlich auszuführen. Somit kann man den Service als einfache Continuous Integration-Lösung sehen. Man wählt das Intervall aus, in dem die eine definierte Sammlung von API-Requests laufen lassen will und startet es. Sollte einer dieser Requests nicht mehr passend antworten, bekommt man eine E-Mail.
    Aber woher weiß Postman, was “passend” ist? Ganz einfach, wir können es beschreiben. Postman bietet ein JavaScript-Testsystem an, das man frei verwenden kann. Wir können also Tests schreiben, die nach dem Abruf eines Requests aufgeführt werden und dort testen, ob auch alles richtig lief. Auch diese können wieder die Variablen aus der Umgebung auslesen und funktionieren somit für alle Staging-Instanzen funktionieren.
  • Dokumentation: Ja, es ist ein nicht so beliebtes Thema: das Schreiben von Dokumentation. Postman nimmt einem das zum großen Teil ab. Aus den hinterlegten Requests generiert, wenn man das so will, Postman eine API-Dokumentation. Die kann man dann mit Beispielen anreichern und eine kleine Beschreibung an den Request hängen. Fertig.

Postman kann in allen Disziplinen der API-Entwicklung ein sehr hilfreicher Begleiter sein. Wir nutzen dabei alle beschriebenen Features und sind sehr begeistert. Wer das Werkzeug in größeren Teams nutzten will, der muss auf die Pro-Version wechseln, welche aber auch erschwinglich ist.