Importer et exporter

Changer de client d'API ne devrait pas signifier perdre des années de travail. Echo importe les données depuis les outils que vous utilisez probablement déjà et vous laisse toujours repartir avec vos données.

Importer depuis Postman

Echo importe les collections et les environnements Postman, les deux avec une fidélité totale à l'aller comme au retour. L'arborescence de dossiers, les requêtes et les variables arrivent intactes, et vous pouvez réexporter aux formats Postman à tout moment. Essayer Echo n'est pas une voie sans retour.

  1. Exportez vos collections et vos environnements depuis Postman.
  2. Importez les fichiers dans Echo.
  3. Vérifiez que vos requêtes sont résolues dans les environnements importés, puis poursuivez votre travail.

Importer depuis Insomnia et Bruno

Si vous venez d'Insomnia ou de Bruno, le principe est le même : exportez depuis votre outil actuel et importez dans Echo. Vos requêtes arrivent dans des collections que vous pouvez immédiatement réorganiser avec les outils décrits dans /docs/echo/collections-and-sharing.

Importer une spécification OpenAPI 3

Fournissez à Echo un document OpenAPI 3, en JSON ou YAML, et il crée des requêtes depuis la spécification avec une inférence automatique du type de requête. Les opérations deviennent ainsi le bon type de requête au lieu d'un ensemble d'ébauches génériques. C'est le moyen le plus rapide de commencer à explorer une API dont vous possédez le contrat, mais que vous n'avez jamais appelée.

Importer une commande cURL

Collez une commande cURL et Echo la transforme en véritable requête. C'est pratique pour les commandes présentes dans les tickets d'incident, la documentation d'API et l'historique du terminal. Si votre organisation dispose de licences Pro AI, une importation cURL assistée par l'IA est également proposée pour les cas plus difficiles. Consultez /docs/echo/ai-features.

Exporter votre travail

Exportez vos collections aux formats Postman ou en OpenAPI 3.1 JSON. OpenAPI fournit une spécification utilisable dans d'autres outils d'API. L'export Postman vous permet de conserver votre façon de travailler avec vos collections.

Conserver une collection dans un dossier

Liez une collection à un dossier pour conserver ses requêtes et ses environnements dans des fichiers JSON lisibles, à côté de votre projet. Vous pouvez examiner les changements avec vos outils habituels et ajouter ces fichiers au contrôle de version.

Echo indique si des changements viennent de l'application, du dossier ou des deux. Choisissez d'importer ou d'exporter pour les appliquer ; lier un dossier ne crée aucun commit et ne fait aucun push Git. Les valeurs secrètes restent hors des fichiers exportés. Utilisez des références de variables pour les identifiants et relisez les fichiers avant de les partager.

Publier la documentation d'API dans DocuVault

L'export de documentation publie une collection sous forme de documentation d'API en Markdown dans Gapfy DocuVault. Au lieu d'une page wiki qui devient obsolète, l'espace documentaire de votre équipe reçoit une documentation produite depuis la collection que vous exécutez réellement.

  1. Choisissez la collection à documenter.
  2. Lancez l'export de documentation.
  3. Retrouvez dans DocuVault la documentation d'API en Markdown générée, prête à être partagée avec votre équipe.

Partager la documentation par lien

Avec une offre Echo payante et les autorisations nécessaires, publiez la documentation d'une collection synchronisée et copiez son lien public. Vous pouvez publier une version mise à jour, renouveler le lien ou révoquer la publication. Toute personne disposant du lien public peut lire le contenu : vérifiez-le avant de le partager. Cette publication est distincte de l'export Markdown vers DocuVault.

Étapes suivantes

  • Organisez ce que vous avez importé : /docs/echo/collections-and-sharing
  • Reliez les requêtes importées aux environnements : /docs/echo/environments-and-variables