API-Werkzeuge

Postman zu OpenAPImit prüfbarem Ergebnis

Collection, Spezifikation oder Umgebung laden und vor dem Export die Anfragen sowie den Konvertierungsbericht prüfen.

Postman zu OpenAPI

Collection, Spezifikation oder Umgebung

Ergebnis

Der Text bleibt in diesem Browser. Keine API-Aufrufe, Skriptausführung oder externen Referenzabrufe.

Ausgabeoptionen

Beispiele statt eines vollständigen Vertrags. Bericht und verbliebene Platzhalter prüfen.

500.000 Zeichen · Tiefe 60 · 50.000 Knoten · 1.000 Anfragen · 500 Meldungen · 5 Sekunden.

Ergebnis veraltet. Vor dem Export erneut prüfen.

Kopie und Download enthalten die gesamte gewählte Ansicht. Maskierung ändert nur die Ausgabe.

Postman zu OpenAPI hilft, wenn aus einer Sammlung funktionierender Aufrufe ein prüfbarer API-Vertrag werden soll. Ein Request zeigt einen konkreten Fall; die Spezifikation beschreibt zulässige Eingaben. Diese Informationen sind nicht deckungsgleich.

Für die Gegenrichtung behalten Sie die ursprüngliche Spezifikation. Authentifizierungsplatzhalter, Antwortdefinitionen und Validierungsregeln benötigen weiterhin eine Prüfung, auch wenn die erzeugte Collection bereits syntaktisch lesbar ist.

Warum Postman zu OpenAPI hier prüfen?

Anfragen und Auslassungen zusammen sehen

Postman zu OpenAPI liest verschachtelte Ordner rekursiv und übernimmt ihren Pfad als Tag der Operation. Die Anfrageübersicht zeigt die erfassten Aufrufe; der Bericht nennt Skripte, Variablen und nicht übertragene Felder. Doppelte Kombinationen aus Methode und Pfad stoppen den Vorgang.

Anfragekarten aus Ordnern führen zu einem API-Dokument; eine Skriptkarte wird zu einer Warnung geleitet.

Zugangsdaten vor der Weitergabe prüfen

Beim Formatieren und beim Umgebungsexport ist die Maskierung standardmäßig aktiv. Erkannte sensible Werte werden in der Ausgabe ersetzt. Deaktivierte Umgebungszeilen erscheinen gesondert im Bericht, damit weniger Zeilen in der .env-Datei nachvollziehbar bleiben.

Umgebungszeilen wandern in eine Konfigurationsdatei, ein Geheimnis wird verdeckt und eine deaktivierte Zeile erscheint im Bericht.

Drei Entscheidungen vor dem Export

01

Zuerst die Eingabeart wählen

Ein Richtungswechsel ersetzt den Text nicht. Laden Sie anschließend das passende Beispiel oder eine lokale Datei. Eine Collection muss das Schema 2.1 deklarieren, eine Umgebungsdatei ein values-Array enthalten.

02

Den Aktualisierungszeitpunkt beachten

Die Automatik wartet nach Änderungen 350 ms. Zum gesammelten Bearbeiten schalten Sie sie aus und starten mit Strg/Cmd + Enter. Geänderte Eingaben oder Optionen sperren Kopieren und Download bis zum nächsten gültigen Ergebnis.

03

Die geprüfte Ansicht exportieren

Ergebnis liefert das Zieldokument, Anfragen die vollständige Übersicht und Bericht sämtliche Codes mit Quellpfaden. Die Anzeige wächst in Schritten von 50 Einträgen; der Export enthält dennoch alle Einträge der gewählten Ansicht.

Von der Anfrage zur Beschreibung und zurück

Collections in beide Richtungen konvertieren

Sie können eine Postman Collection konvertieren und OpenAPI 3.0.3 als JSON oder YAML speichern. Um OpenAPI in Postman importieren zu können, erzeugt die Gegenrichtung Collection 2.1 aus 3.0 oder 3.1. Lokale Referenzen für Operationsdetails werden aufgelöst.

Beispiele ohne erfundene Einschränkungen

Query- und Headerwerte werden zu String-Beispielen. JSON-Bodys bleiben Beispiele ohne automatisch abgeleitete required- oder enum-Regeln. Rückwärts werden explizite Beispiele beziehungsweise Standardwerte verwendet; sonst entstehen benannte Platzhalter statt zufälliger Testdaten.

Server und Authentifizierung nachvollziehen

Basic, Bearer und API Keys in Header oder Query werden abgebildet. Bei Servern gilt Operation vor Pfad vor Wurzel; aus der wirksamen Liste wird der erste gewählt. Mehrere Möglichkeiten, fehlende Server und komplexe Sicherheitskombinationen werden gemeldet.

Umgebungen getrennt weitergeben

Postman Umgebungsvariablen stammen aus einer eigenständigen JSON-Datei. Aktive skalare Werte werden Strings, null wird leer. Die Quotierung erhält Leerzeichen, Zeilenumbrüche und Dollarzeichen. Ungültige oder doppelte Schlüssel führen zum Abbruch.

Grenzen der Übertragung

Versionen bewusst begrenzt
Akzeptiert werden Collection 2.1 sowie OpenAPI 3.0.x und 3.1.x. Swagger 2.0, andere Collection-Versionen und OpenAPI 3.2 werden zurückgewiesen. Die erzeugte Spezifikation verwendet immer OpenAPI 3.0.3.
Skripte bleiben ohne Laufzeit
Pre-Request-Skripte und Tests werden weder ausgeführt noch in Assertions übersetzt. Formatieren erhält ihren Text, Konvertieren meldet die Auslassung. Dynamische Variablen werden nicht ausgewertet; Umgebung, globale Werte und Vault werden nicht automatisch zusammengeführt.
Kein verlustfreier Vertragsimport
Die Gegenrichtung lässt Antwortdefinitionen und Validierungsregeln aus und meldet dies. Komplexe Parameterserialisierung, Callbacks, Webhooks, OAuth-Flows, Signaturen und binäre Dateiinhalte liegen außerhalb der Abbildung. Ein Beispiel beweist keine vollständige Serverregel.
Referenzen und fehlende Server
Externe Dateien und URL-Referenzen werden nicht abgerufen. Fehlende lokale Ziele oder ungültige Verträge stoppen die Verarbeitung. Eine nicht auflösbare Collection-Basis führt zu / als Server; ohne Server verwendet die Gegenrichtung example.invalid und einen Berichtseintrag.
Maskierung ist keine umfassende Geheimnissuche
Sensible Schlüsselnamen, als secret markierte Variablen, Authentifizierungswerte, Cookies und URL-Zugangsdaten werden erkannt. JSON-Bodys werden strukturell geprüft, sonstige Bodys vollständig maskiert. Freier Text und Skripte können weiterhin Geheimnisse enthalten; die Eingabe bleibt unverändert.
Feste Grenzen und eindeutige Fehler
Maximal 500.000 Eingabezeichen, Tiefe 60, 50.000 Knoten, 1.000 Anfragen und 500 Meldungen; Ergebnispaket bis 2.000.000 Zeichen und fünf Sekunden Rechenzeit. Doppelte Schlüssel, ungenaue Zahlen, YAML-Aliasse, eigene Tags und mehrere Dokumente sind ausgeschlossen.

Fragen zu Postman zu OpenAPI

Werden Spezifikationen in YAML und JSON unterstützt?

Ja, für OpenAPI → Collection. Collections und Umgebungsdateien werden als JSON gelesen. Die Formatauswahl gilt nur für die OpenAPI-Ausgabe; Collections bleiben JSON, Umgebungen werden .env-Dateien.

Gehen bei der Umwandlung Informationen verloren?

Ja. Ein ausführbarer Ablauf und ein deklarativer Vertrag beschreiben unterschiedliche Dinge. Prüfen Sie jeden Berichtseintrag. Das Ergebnis dient als Ausgangspunkt einer Migration und bestätigt weder funktionierende Authentifizierung noch korrekte Live-Antworten.

Wie wird baseUrl in der erzeugten Collection festgelegt?

Die Serverwahl folgt Operation > Pfad > Wurzel. Die erste wirksame URL wird baseUrl; weitere Operationen erhalten eigene Basisvariablen. Servervariablen werden mit Standardwerten ersetzt. Ohne Server wird example.invalid gesetzt und gemeldet.

Lässt sich der Export geheimer Variablen verhindern?

Mit aktiver Maskierung ersetzt dieses Werkzeug secret-markierte oder anhand ihres Namens erkannte Werte durch [REDACTED]. Es ändert keine Postman-Berechtigungen und erkennt nicht beliebige Geheimnisse in freiem Text. Prüfen Sie daher die konkrete Ausgabe.

Enthält eine exportierte Collection alle Umgebungsvariablen?

Nein. Exportieren Sie die Umgebung separat und verwenden Sie Umgebung → .env. Verarbeitet werden nur die aktiven Werte dieser Datei. Fehlende lokale, globale oder Vault-Werte werden nicht nachgeladen.

Ein konkretes Dokument macht Probleme?

Mit einer kleinen Collection beginnen

Prüfen Sie mit Postman zu OpenAPI zuerst wenige Anfragen. Vergleichen Sie Übersicht und Bericht mit dem Original, ergänzen Sie ungelöste Platzhalter und speichern Sie das benötigte Ergebnis.