Warum Collections?

Request Collections sind das Herzstück vieler Entwicklungs- und Testprojekte. Sie dienen dazu, HTTP-Requests zu organisieren und zu strukturieren, was besonders in größeren Projekten von Bedeutung ist. Sie sind besonders aus folgenden Gründen hilfreich:

1. Organisation und Struktur: In einem Entwicklungsprojekt können Hunderte von HTTP-Requests erforderlich sein. HTTP-Request Collections helfen dabei, diese Requests übersichtlich zu organisieren und zu kategorisieren, was die Verwaltung erheblich erleichtert.
2. Testen und Debuggen: Beim Testen von APIs müssen Entwickler:innen oft verschiedene Anfragen in einer bestimmten Reihenfolge ausführen. Request Collections ermöglichen es, Testfälle zu erstellen und diese systematisch durchzuführen, um Fehler zu identifizieren und zu beheben.
3. Teamzusammenarbeit: In größeren Entwicklungsprojekten arbeiten Teams zusammen. Request Collections bieten eine Möglichkeit, Anfragen und Testfälle zwischen Teammitgliedern zu teilen und zu synchronisieren.
4. Dokumentation: Request Collections können auch als Dokumentationsquelle dienen, um APIs und deren Endpunkte zu beschreiben. Dies erleichtert anderen Entwickler:innen das Verständnis der API und deren Verwendung.
5. Wiederverwendbarkeit: Entwickler:innen können häufig verwendete Anfragen in Sammlungen speichern und sie bei Bedarf wiederverwenden, was Zeit und Aufwand spart.

Nun stellt sich natürlich die Frage: mit welchem Tool verwalte ich meine Collection? Schauen wir uns drei bekannte Vertreter an.

Postman: der Klassiker

Postman ist wohl das bekannteste Tool zur Verwaltung von Request Collections. Mit seiner benutzerfreundlichen Oberfläche können User HTTP-Anfragen erstellen, bearbeiten und testen sowie automatisierte Testszenarien erstellen. Postman unterstützt alle gängigen HTTP-Methoden und bietet Funktionen wie das Verwalten von Umgebungen und die Generierung von Dokumentationen. Es ermöglicht die einfache Zusammenarbeit im Team, da Anfragen und Sammlungen geteilt und synchronisiert werden können. Postman bietet auch eine Vielzahl von Integrationen und ist in der Lage, den gesamten API-Entwicklungslebenszyklus zu unterstützen. Zu beachten ist, dass ab einer bestimmten Teamgröße eine kostenpflichtige Lizenz erforderlich ist.

Als Importmöglichkeiten stehen hier nur das hauseigene Format sowie OpenAPI zur Verfügung.

Postman ermöglicht es, Sammlungen im eigenen JSON Format zu exportieren. Ein Export enthält sowohl die Requests als auch die Environments, jedoch in getrennten Dateien. Interessanterweise steht sogar ein JSON Schema für das Postman-Format zur Verfügung – es ist unter diesem Link zu finden.

Website: Postman

Insomnia: der Herausforderer

Auch Insomnia hat sich schon länger einen Namen gemacht. Die Ähnlichkeit zu Postman ist unverkennbar. Insomnia bietet erweiterte Funktionen wie Umgebungsvariablen, Codegenerierung und einen leistungsstarken Request-Editor, um den Test- und Debugging-Prozess zu optimieren. Insomnia ist bekannt für seine Echtzeit-Kollaborationsfähigkeiten und steht (derzeit) kostenlos zur Verfügung, was Entwickler:innen ein wertvolles Werkzeug zur Verbesserung ihres API-Entwicklungs-Workflows bietet.

Insomnia akzeptiert als Importquelle eine Reihe von Formaten, darunter Postman v2, OpenAPI und natürlich das eigene JSON Format.

Es ermöglicht das Exportieren von Sammlungen in einem Format, das sowohl die Requests als auch die Umgebungen enthält, es sei denn, sie sind als privat markiert. Mithilfe eines Plugins ist auch ein Export als Postman Collection möglich.

Website: Insomnia

Hoppscotch: das Open-Source-Juwel

Hoppscotch (ehemals Postwoman) ist eine Open-Source-Webanwendung für API-Tests. Auch hier besteht in der Oberfläche eine große Ähnlichkeit zu den anderen Tools, was eine Umgewöhnung recht leicht macht. Im Gegensatz zu den anderen beiden Kandidaten läuft Hoppscotch auf einem Server und kann über den Browser aufgerufen werden. Das ermöglicht ein Hosting und das leichte Teilen von Collections innerhalb einer Firma. Aber auch ein lokaler Betrieb ist möglich, z.B. via Docker. Hoppscotch steht unter der MIT-Lizenz und kann kostenlos genutzt und modifiziert werden.

Als Importoptionen haben wir hier die Wahl zwischen Postman v2, Insomnia, OpenAPI oder dem eigenen Format.

In Hoppscotch werden Exporte separat für Anfragen und Umgebungen durchgeführt und im eigenen JSON Format gespeichert.

Website: Hoppscotch

Der Unterschied in den Formaten

Ein wichtiger Punkt ist zu beachten: der Übergang von einem Tool zum anderen kann eine Herausforderung darstellen, da jedes Tool seine eigenen Formate für Collections verwendet. Beim Exportieren aus einem Tool und Importieren in ein anderes können Informationen verloren gehen oder nicht kompatibel sein, insbesondere Daten wie Variablen, Platzhalter und generierte IDs werden oft nicht wieder korrekt importiert. Nur weil theoretisch ein Format importiert werden kann, heißt das noch lange nicht, dass es auch wirklich gut funktioniert. Als Faustregel gilt: je einfacher eine Collection aufgebaut ist, desto eher klappt der Import.

Daher ist es ratsam, als Team ein Tool auszuwählen und sich darauf zu einigen, um Probleme beim Wechsel zwischen den Tools zu vermeiden und auch komplexere Features nutzen zu können. Dann hat man auch die Möglichkeit, die exportierte Collection z.B. in seinem Git Projekt abzulegen, sodass diese mitversioniert wird und für alle gut zugänglich ist.

Die richtige Wahl treffen

Postman, Insomnia und Hoppscotch sind alle valide Optionen. Die Wahl des richtigen Tools und das Festhalten daran erleichtert die Zusammenarbeit, spart Zeit und verhindert mögliche Probleme beim Wechsel zwischen den Tools. Wünschenswert wäre ein offener Standard zur Speicherung von Collections, der von allen Tools unterstützt wird und den Nutzer:innen damit die Wahlfreiheit gibt. Momentan ist das aber noch keine Option – und könnte auch leicht im Standardproblem enden.

Der Beitrag HTTP Request Collections – die Qual der Wahl erschien zuerst auf Business -Software- und IT-Blog - Wir gestalten digitale Wertschöpfung.