Importation et exportation
Echo permet de reprendre les requêtes d'un autre client d'API, de conserver une collection près du code et de générer de la documentation. Ces opérations ont des résultats distincts et traitent les secrets différemment.
Importer une collection ou un environnement
- Exportez depuis l'outil actuel et conservez le fichier d'origine.
- Ouvrez la section d'importation des paramètres d'Echo, sélectionnez l'espace de destination et le fichier source. Echo détecte le format.
- Vérifiez l'aperçu, les quantités et les avertissements avant de confirmer.
- Ouvrez une requête importée, sélectionnez son environnement et vérifiez URL, authentification, corps et scripts avant l'envoi.
Echo accepte les collections et environnements Postman. Lorsque le format est pris en charge, l'authentification héritée de Postman est copiée dans les requêtes importées ; elle ne crée pas d'authentification modifiable au niveau de la collection Echo. Les corps binaires et références de fichiers ne passent pas simplement d'un ordinateur à l'autre et peuvent être ignorés avec un avertissement. Une authentification non prise en charge produit aussi un avertissement. Rattachez les fichiers et corrigez les identifiants avant d'utiliser ces requêtes.
Les exports Insomnia et collections Bruno offrent d'autres voies de migration. Leurs modèles de données diffèrent. Vérifiez le résultat plutôt que de supposer que toutes les fonctions d'origine survivent à un export suivi d'un nouvel import.
Commencer avec OpenAPI ou cURL
Importez un document OpenAPI 3 en JSON ou YAML pour créer des requêtes depuis ses opérations. Vérifiez URL, paramètres, corps et réglages de sécurité générés. Une spécification décrit une API ; l'importer ne prouve pas que le serveur l'implémente.
L'assistant d'importation cURL utilise l'IA et exige une licence Pro AI. Ouvrez-le depuis la palette de commandes ou le menu de nouvelle requête, puis collez la commande. Vérifiez URL, méthode, en-têtes et corps proposés avant de créer la requête. Contrôlez identifiants et fichiers référencés avant l'envoi. Consultez les fonctions d'IA pour l'accès et le traitement des données.
Choisir un format d'exportation
L'export Postman rend les collections disponibles dans cet outil ; l'export d'environnement crée un fichier distinct. Les exports d'environnements Postman incluent les valeurs secrètes, marquées comme secrètes dans le fichier. Traitez ces fichiers comme des identifiants, pas comme des pièces jointes sans risque.
L'export OpenAPI produit un document OpenAPI 3.1 JSON pour les opérations HTTP. Les autres protocoles sont comptés comme exclus ; ce format ne sauvegarde pas tout l'espace de travail. Vérifiez le résultat et la spécification. Les valeurs secrètes d'environnement sont omises des variables de serveur, mais les identifiants écrits directement dans les requêtes restent à vérifier.
Lier une collection à un dossier
Depuis le menu de la collection, liez un dossier vide dans lequel vous pouvez écrire. Echo crée des fichiers JSON lisibles pour la collection, les requêtes et les environnements. Utilisez un dossier distinct pour chaque arborescence liée ; les liens qui se chevauchent sont refusés.
Le panneau signale les modifications dans Echo, sur disque ou des deux côtés. Exporter envoie la version Echo au dossier ; importer ramène la version du dossier dans Echo. Si les deux ont changé, examinez le conflit et choisissez explicitement la version à appliquer. L'importation automatique est facultative. Supprimer le lien n'efface ni la collection ni les fichiers.
Ce format omet les valeurs des variables secrètes, mais peut conserver leurs références. Cette protection diffère de l'export d'environnement Postman. Utilisez des variables pour les identifiants et vérifiez scripts, corps et en-têtes avant un commit. Echo ne crée aucun commit et ne fait aucun push Git. La CLI de bureau utilise le même format.
Exporter du Markdown vers DocuVault
Connectez-vous, sélectionnez une collection et choisissez l'export de documentation. Echo génère du Markdown et l'envoie vers DocuVault. Un document existant portant le même nom généré reçoit une nouvelle version. Vérifiez le message de fin et le fichier avant de le partager.
Répétez l'export après avoir modifié la collection. Le document représente cet instant ; il ne suit pas automatiquement chaque modification.
Publier la documentation par lien public
Pour une collection synchronisée, le panneau permet aux personnes autorisées avec une offre Echo payante de publier une version, copier son URL, la mettre à jour, renouveler le lien ou révoquer l'accès. Toute personne ayant le lien public peut lire le document. Vérifiez exemples et identifiants avant de publier.
Publiez de nouveau après une modification de la collection. Renouveler le lien remplace l'URL des lecteurs ; révoquer coupe l'accès à la publication. Ces actions ne récupèrent pas les copies déjà téléchargées. La publication est indépendante du fichier DocuVault.
Pour réutiliser les réglages, consultez environnements. Pour convertir C#, TypeScript, JavaScript, Java, Python ou JSON Schema, consultez contrats.