Import und Export

Der Wechsel zwischen API-Clients sollte nicht bedeuten, dass jahrelange Arbeit verloren geht. Echo importiert aus den Werkzeugen, die du wahrscheinlich heute nutzt, und sperrt deine Daten niemals ein.

Aus Postman importieren

Echo importiert Postman-Sammlungen und -Umgebungen mit vollständiger Treue beim Import und Rückexport. Deine Ordnerstruktur, Anfragen und Variablen kommen unversehrt an, und du kannst jederzeit wieder in Postman-Formate exportieren. Echo auszuprobieren ist keine Einbahnstraße.

  1. Exportiere deine Sammlungen und Umgebungen aus Postman.
  2. Importiere die Dateien in Echo.
  3. Prüfe, ob die Variablen deiner Anfragen mit den importierten Umgebungen korrekt aufgelöst werden, und arbeite dann weiter.

Aus Insomnia und Bruno importieren

Der Wechsel von Insomnia oder Bruno funktioniert genauso: Exportiere aus deinem bisherigen Werkzeug und importiere in Echo. Deine Anfragen landen in Sammlungen, die du sofort mit den unter /docs/echo/collections-and-sharing beschriebenen Werkzeugen neu ordnen kannst.

Eine OpenAPI 3-Spezifikation importieren

Übergib Echo ein OpenAPI 3-Dokument in JSON oder YAML. Echo erstellt daraus Anfragen und erkennt ihren Typ automatisch, sodass Operationen als die richtige Art von Anfrage statt als eine Reihe generischer Stubs angelegt werden. So kannst du am schnellsten eine API erkunden, für die du einen Vertrag besitzt, die du aber noch nie aufgerufen hast.

Einen cURL-Befehl importieren

Füge einen cURL-Befehl ein, und Echo wandelt ihn in eine vollständige Anfrage um. Das ist praktisch für Befehle aus Fehlerberichten, API-Dokumentationen und dem Terminalverlauf. Wenn deine Organisation Pro-AI-Lizenzen hat, steht für schwierigere Fälle auch ein KI-gestützter cURL-Import zur Verfügung. Siehe /docs/echo/ai-features.

Deine Arbeit exportieren

Exportiere Sammlungen in Postman-Formate oder als OpenAPI 3.1 in JSON. Mit OpenAPI erhältst du eine Spezifikation für andere API-Werkzeuge. Der Postman-Export erhält deinen bisherigen Workflow mit Sammlungen.

Eine Sammlung in einem Ordner verwalten

Verknüpfe eine Sammlung mit einem Ordner, um Anfragen und Umgebungen als lesbare JSON-Dateien neben deinem Projekt zu speichern. Du kannst Änderungen mit deinen gewohnten Werkzeugen prüfen und die Dateien in die Versionsverwaltung aufnehmen.

Echo zeigt, ob Änderungen aus der App, dem Ordner oder beiden stammen. Wähle Import oder Export, um sie zu übernehmen. Die Ordnerverknüpfung führt keine Git-Commits oder Pushes aus. Geheime Werte bleiben außerhalb der exportierten Dateien. Verwende Variablenreferenzen für Zugangsdaten und prüfe die Dateien vor dem Teilen.

API-Dokumentation in DocuVault veröffentlichen

Der Dokumentationsexport veröffentlicht eine Sammlung als API-Dokumentation in Markdown in Gapfy DocuVault. Statt einer veraltenden Wiki-Seite erhält der Dokumentenbereich deines Teams eine Dokumentation aus der Sammlung, die ihr tatsächlich ausführt.

  1. Wähle die Sammlung, die du dokumentieren möchtest.
  2. Starte den Dokumentationsexport.
  3. Du findest die erzeugte API-Dokumentation in Markdown anschließend in DocuVault, bereit zur Freigabe für dein Team.

Mit einem kostenpflichtigen Echo-Tarif und den nötigen Berechtigungen kannst du die Dokumentation einer synchronisierten Sammlung veröffentlichen und ihren öffentlichen Link kopieren. Du kannst eine aktualisierte Version veröffentlichen, den Link erneuern oder die Veröffentlichung widerrufen. Jeder mit dem öffentlichen Link kann den Inhalt lesen. Prüfe ihn deshalb vor dem Teilen. Diese Veröffentlichung ist vom Markdown-Export nach DocuVault getrennt.

Nächste Schritte

  • Importierte Inhalte organisieren: /docs/echo/collections-and-sharing
  • Importierte Anfragen mit Umgebungen verbinden: /docs/echo/environments-and-variables