Bevor man eine API veröffentlicht oder Drittanbieter-APIs integriert, ist es entscheidend, sicherzustellen, dass alles reibungslos funktioniert. Dafür gibt es Plattformen wie Postman, die Nutzern und Entwicklern einen API-Client zur Verfügung stellen, mit dem man APIs erstellen, organisieren und testen kann (sowie diese nach der Produktion überwachen).

Was ist Postman?

Postman ist eine Plattform für die Entwicklung und das Testen von APIs, die es ermöglicht, Sammlungen zu erstellen und zu teilen, Tests zu automatisieren und die Performance von Application Programming Interfaces zu überwachen. 

Wie andere ähnliche Plattformen hat Postman das Ziel, die Entwicklung und Bereitstellung neuer APIs zu vereinfachen und zu beschleunigen, indem es eine Umgebung bereitstellt, in der alle Aspekte der eigenen APIs verwaltet werden können, und die Zusammenarbeit zwischen Entwicklern erleichtert.

Über die grafische Benutzeroberfläche lassen sich HTTP-Anfragen ausführen, Tests mit JavaScript-Skripten automatisieren, Serverantworten anzeigen und APIs in Sammlungen von Anfragen organisieren. Weitere nützliche Funktionen der Plattform sind die Simulation von API-Antworten, die Generierung von Dokumentationen und Code in verschiedenen Programmiersprachen sowie die Möglichkeit, öffentliche APIs über das Postman API Network zu erkunden.

Die Hauptfunktionen von Postman

Als All-in-One-API-Plattform wurde Postman entwickelt, um Entwickler während des gesamten API-Lebenszyklus – von Design bis Monitoring – zu unterstützen. Sein Hauptzweck ist es daher, einen API-Client bereitzustellen, also ein Tool, das die Kommunikation mit APIs ermöglicht, sowie einen Raum, in dem Antworten, Vorlagen und Dokumentationen gespeichert und organisiert werden können. 

Kurz zusammengefasst lassen sich die wichtigsten Funktionen von Postman wie folgt beschreiben:

• API-Client: Postman ist im Wesentlichen ein API-Client, mit dem APIs einfach erstellt, getestet, organisiert und wiederverwendet werden können. Der Client erkennt automatisch die Sprache der Antwort und unterstützt verschiedene Authentifizierungsprotokolle;
• API-Repository: eine der Hauptfunktionen von Postman ist es, alle Materialien rund um die API-Entwicklung in einer zentralisierten Plattform zu speichern, zu katalogisieren und zu teilen, sodass Spezifikationen, Dokumentationen, Testfälle und Statistiken organisiert werden können;
• Gemeinsame Arbeitsumgebung: ein weiteres zentrales Ziel von Postman ist es, die Zusammenarbeit zwischen Entwicklern (und nicht nur) zu erleichtern, was durch gemeinsam genutzte Arbeitsbereiche mit Teammitgliedern oder externen Nutzern möglich wird.

Eine weitere wichtige Funktion des Postman-API-Clients betrifft die Governance. Die Plattform ermöglicht es, interne Standards festzulegen und Vorlagen für Anfragen, Antworten und Tests zu definieren, wodurch die Entwicklung sicherer und konsistenter APIs erleichtert wird und deren unkontrollierte Vermehrung vermieden werden kann.

Postman-API-Plattform: Wo anfangen

Die API-Tools von Postman sind über eine Desktop-Anwendung verfügbar, die für Windows, macOS und Linux erhältlich ist. Wer Postman nicht herunterladen möchte, kann die Webversion nutzen, sollte aber wissen, dass die Online-Version nicht alle Funktionen der Desktop-Version bietet (z. B. ist es nicht möglich, den API-Verkehr über Proxy zu erfassen).

Die Arbeitsumgebung besteht aus mehreren Sektionen, darunter:

• Workspaces: ermöglichen es, APIs zu organisieren und mit anderen Entwicklern zusammenzuarbeiten, indem die Arbeit synchronisiert wird. Sie können Intern (nur für das Team zugänglich), Partner (für bestimmte eingeladene Nutzer) oder Öffentlich (für alle zugänglich) sein;
• Request Builder: Bereich zur Konfiguration von HTTP-Anfragen (Methode, URL, Header usw.);
• Response Viewer: hier werden die Serverantworten angezeigt (im JSON-, XML-, HTML- oder Textformat);
• Sammlungen: organisierte Sets von API-Anfragen, die wiederverwendet, automatisiert und geteilt werden können;
• Flows: grafische Oberfläche zur Erstellung automatisierter Test- und API-Interaktionsflüsse;
• APIs: Bereich, in dem APIs zentral verwaltet und dokumentiert werden können;
• Monitors: ermöglichen es, den Zustand von APIs zu überwachen und Benachrichtigungen bei Fehlern zu erhalten.

Durch die Navigation in den verschiedenen Bereichen lassen sich alle API-Aufrufe überprüfen, testen, debuggen und überwachen. 

Die Postman-Tools für die API-Entwicklung

Um zu verstehen, wie man Postman zum Testen von APIs, zur Dokumentation und zur Überwachung der Performance nutzt, lohnt es sich, die wichtigsten von der Plattform bereitgestellten API-Tools vorzustellen:

• Design: der visuelle Editor von Postman ermöglicht es, API-Endpunkte zu erstellen und deren Parameter, Request- und Response-Payloads sowie Authentifizierungseinstellungen festzulegen und zu dokumentieren. Die API-Spezifikationen können in den Formaten OpenAPI, RAML, GraphQL oder SOAP entworfen werden. Von hier aus können auch Sammlungen generiert werden, die für Mockups, Tests, Monitoring oder andere Entwicklungsphasen genutzt werden können;
• Test: automatisiertes API-Testing mit Postman ermöglicht die Einrichtung von Continuous-Integration- und Continuous-Deployment-Workflows (CI/CD), die Verwendung von Post-Response-Skripten zum Debuggen sowie die Durchführung von Unit-Tests, Integrationstests und Lasttests;
• Mock-Server: diese Server, die auch lokal und in Testumgebungen verfügbar sind, ermöglichen es, genau zu sehen, wie eine API ausgeführt wird, bevor sie in Produktion geht, und API-Endpunkte zu simulieren, wenn keine echten API-Anfragen möglich sind;
• Monitors: diese Monitore, die in der Postman-Cloud gehostet werden, ermöglichen die Überwachung des API-Status und der Performance. Sie können in verschiedenen Regionen ausgeführt und mit externen Alarm- und Dashboard-Systemen integriert werden;
• API-Detection: dieses Tool ermöglicht es, Anfragen abzufangen und zu inspizieren, die zwischen Client-Anwendungen und APIs übertragen werden, indem HTTP- und HTTPS-Verkehr erkannt wird. 

Wie nutzt man Postman zum Testen der Openapi-APIs?

Postman ist nicht nur für Entwickler, sondern auch für API-Nutzer äußerst hilfreich. Es ermöglicht nicht nur den Zugriff auf die offizielle Dokumentation von Drittanbieter-APIs – inklusive URLs, verfügbarer Endpunkte, HTTP-Methoden (GET, POST usw.) und verwendeter Formate (z. B. JSON) – sondern auch das Testen von APIs und die Überprüfung ihrer Kompatibilität mit den eigenen Systemen über Integrationstests.

Zusätzlich zu Unit-Tests einzelner Anfragen und Antworten können End-to-End-Tests, Regressionstests durchgeführt werden, um sicherzustellen, dass APIs auch nach Änderungen und Updates weiterhin funktionieren, sowie Performance-Tests, die es ermöglichen, den Benutzerverkehr zu simulieren und das Verhalten der APIs unter Last zu beobachten.

Alle APIs von Openapi sind in Postman-Sammlungen organisiert und für die Nutzer verfügbar. Um eine bestimmte API zu testen, genügt es, die Openapi-Konsole aufzurufen, die gewünschte API auszuwählen und auf der Seite „Dokumentation“ dem Link zu Postman zu folgen, der direkt zu unseren API Collections führt.