Wie importiere ich eine API-Spezifikation (z.B. OpenAPI) in Postman?
- Vorbereitung: API-Spezifikation bereitstellen
- Importvorgang in Postman starten
- Datei auswählen oder URL eingeben
- Import abschließen und API in Postman verwenden
- Tipps für den Umgang mit importierten Spezifikationen
Vorbereitung: API-Spezifikation bereitstellen
Bevor du eine API-Spezifikation in Postman importierst, solltest du sicherstellen, dass du eine gültige OpenAPI-Datei hast. Diese kann entweder im JSON- oder YAML-Format vorliegen und enthält eine ausführliche Beschreibung der verfügbaren Endpunkte, Parameter, Authentifizierungsmethoden und anderer API-Eigenschaften. Häufig wird die Datei openapi.json oder swagger.yaml genannt.
Importvorgang in Postman starten
Öffne zuerst die Postman-Anwendung. Im Hauptbildschirm findest du oben links einen Button mit der Bezeichnung Import. Mit einem Klick darauf öffnet sich ein Dialogfenster, das verschiedene Importmöglichkeiten bietet. Postman unterstützt den Import von Dateien, Ordnern, Links und Rohtext.
Datei auswählen oder URL eingeben
Um deine OpenAPI-Spezifikation zu importieren, kannst du entweder die entsprechende Datei direkt hochladen oder eine Webadresse angeben, wenn die Spezifikation online gehostet wird. Im Importfenster gibt es einen Tab namens File, in dem du die Datei von deinem Computer auswählen kannst, indem du sie hineinziehst oder über den Datei-Explorer auswählst. Alternativ kannst du im Tab Link die URL angeben, unter der deine API-Spezifikation erreichbar ist. Postman unterstützt dabei sowohl JSON- als auch YAML-Formate.
Import abschließen und API in Postman verwenden
Nach der Auswahl der Datei oder Eingabe der URL klickst du auf den Button Import. Postman analysiert die Datei und legt eine neue Sammlung (Collection) mit allen definierten Endpunkten an. Diese Sammlung kannst du nun öffnen, um einzelne Requests einzusehen, zu testen oder anzupassen. Zusätzlich stellt Postman automatisch wichtige Details wie Parameter, Header oder Authentifizierungsmethoden bereit, sodass du direkt damit arbeiten kannst.
Tipps für den Umgang mit importierten Spezifikationen
Es ist ratsam, die importierte API-Sammlung in Postman regelmäßig zu aktualisieren, falls sich die Spezifikation ändert. Außerdem kannst du Umgebungsvariablen verwenden, um unterschiedliche Server-URLs oder Zugangsdaten dynamisch zu verwalten. Postman bietet zudem die Möglichkeit, Tests und Dokumentationen direkt in der Sammlung zu ergänzen, was die Arbeit mit der API erheblich erleichtert.