01
Faire correspondre le mode au fichier
Changer de direction ne remplace pas le texte. Chargez ensuite l’exemple du mode ou un fichier adapté. Une collection doit déclarer le schéma 2.1 ; un environnement doit posséder un tableau values.
Outils API
Postman vers OpenAPIcontrôler la migration
Chargez une collection, une spécification ou un environnement, puis vérifiez les requêtes et le rapport avant l’export.
Postman vers OpenAPI
Collection, spécification ou environnement
Résultat
Le texte reste dans ce navigateur. Aucun appel API, script exécuté ou téléchargement de référence externe.
Options de sortie
Conversion d’exemples, pas d’un contrat complet. Vérifiez le rapport et les emplacements restants.
500 000 caractères · profondeur 60 · 50 000 nœuds · 1 000 requêtes · 500 signalements · 5 secondes.
Résultat périmé. Relancez la validation avant export.
La copie et le téléchargement incluent toute la vue sélectionnée. Seule la sortie est masquée.
Postman vers OpenAPI sert à transformer un ensemble d’appels concrets en point de départ pour une description d’API. Une requête montre un cas particulier ; un contrat précise les entrées admises. Le passage entre les deux demande donc une vérification des informations manquantes.
Pour créer une collection depuis une spécification, conservez aussi le contrat d’origine. Les paramètres d’authentification, les réponses et les contraintes des modèles ne se retrouvent pas tous dans les requêtes produites.
Pourquoi vérifier Postman vers OpenAPI ici ?
Suivre les requêtes et les omissions
Postman vers OpenAPI parcourt les dossiers imbriqués et reprend leur chemin dans les tags des opérations. La liste permet de vérifier les appels lus ; le rapport signale les scripts, variables et champs non transférés. Deux requêtes ayant le même chemin et la même méthode provoquent une erreur.
Relire les secrets avant le partage
Le formatage et l’export d’environnement activent le masquage par défaut. Les valeurs sensibles reconnues sont remplacées dans la sortie. Les lignes désactivées ont leur propre signalement : une liste .env plus courte reste ainsi explicable.
Trois choix avant de réutiliser le fichier
02
Repérer le moment du recalcul
La conversion automatique attend 350 ms après la dernière modification. Désactivez-la pour regrouper les changements et lancer avec Ctrl/Cmd + Entrée. La copie et le téléchargement restent bloqués tant que le nouveau résultat n’est pas disponible.
03
Exporter la vue examinée
Résultat exporte le document converti, Requêtes la liste complète et Rapport les codes avec leurs chemins d’origine. L’affichage progresse par 50 éléments, mais le téléchargement contient la totalité de la vue choisie.
Relier contrat, appels et configuration
Deux directions dans un convertisseur
Ce convertisseur de collections API produit OpenAPI 3.0.3 en JSON ou YAML. OpenAPI vers Postman accepte les versions 3.0 et 3.1 et génère une collection Postman 2.1. Les références locales nécessaires aux détails des opérations sont résolues dans le document fourni.
Des exemples sans contrat inventé
Les valeurs de query et d’en-têtes deviennent des exemples de chaînes. Un corps JSON reste un exemple, sans ajout arbitraire de required ou enum. Dans l’autre sens, example puis default fournissent les valeurs ; leur absence produit un emplacement nommé.
Des règles précises pour les serveurs
Basic, Bearer et API Key dans les en-têtes ou la query sont représentés. La conversion inverse choisit les serveurs de l’opération, du chemin puis de la racine, et prend le premier effectif. Les choix multiples et les combinaisons de sécurité complexes sont signalés.
Des variables dans un fichier distinct
Les variables d’environnement proviennent d’un export JSON séparé. Les valeurs scalaires actives deviennent des chaînes ; null donne une valeur vide. Les guillemets préservent espaces, sauts de ligne et dollars. Une clé incorrecte ou répétée arrête l’export.
Ce que la conversion ne reconstitue pas
- Versions prises en charge
- L’entrée accepte Collection 2.1, OpenAPI 3.0.x et 3.1.x. Swagger 2.0, les autres versions de collections et OpenAPI 3.2 sont refusés. La spécification générée est toujours en 3.0.3 ; le formatage ne réalise pas de migration de version.
- Aucun moteur de scripts
- Les scripts préalables et les tests ne sont ni exécutés ni traduits en assertions. Le formatage conserve leur texte, tandis que la conversion signale leur omission. Les variables dynamiques ne sont pas évaluées et les portées d’environnement, globales ou Vault ne sont pas fusionnées.
- Une requête ne remplace pas le modèle complet
- La conversion inverse omet les définitions de réponses et les contraintes de validation, avec un signalement. Sérialisation complexe, callbacks, webhooks, flux OAuth, signatures et contenus binaires ne sont pas transférés. Un exemple ne prouve pas les règles du service.
- Références et adresses manquantes
- Aucune référence externe n’est téléchargée. Une cible locale absente ou une spécification invalide bloque le traitement. Une base de collection non résolue devient / ; un serveur absent dans le sens inverse devient example.invalid. Ces choix sont rapportés pour correction.
- Le masquage ne reconnaît pas tout
- Il vise les noms sensibles, les variables secret, les valeurs d’authentification, les cookies et les identifiants d’URL. Les corps JSON sont inspectés ; les autres corps sont entièrement masqués. Du texte libre ou un script peut encore contenir un secret. L’entrée originale n’est pas modifiée.
- Des limites explicites
- Maximum : 500 000 caractères en entrée, profondeur 60, 50 000 nœuds, 1 000 requêtes, 500 signalements, 2 000 000 caractères pour l’ensemble du résultat et cinq secondes de calcul. Clés dupliquées, nombres imprécis, alias YAML, tags personnalisés et documents multiples sont refusés.
Questions sur Postman vers OpenAPI
Les spécifications YAML et JSON sont-elles acceptées ?
Oui, dans le sens OpenAPI → collection. Les collections et les environnements doivent être en JSON. Le choix de format concerne uniquement la spécification générée : la collection sort en JSON et l’environnement en .env.
La conversion entraîne-t-elle des pertes ?
Oui. Un scénario exécutable et un contrat déclaratif ne portent pas les mêmes informations. Relisez le rapport et utilisez la sortie comme base de migration. Le succès de la conversion ne valide ni les accès ni les réponses d’un service réel.
Comment définir baseUrl dans une collection générée ?
La priorité est opération > chemin > racine. La première URL effective devient baseUrl et les opérations suivantes utilisent des variables de base distinctes. Les variables de serveur utilisent leur valeur par défaut. Sans serveur, example.invalid est inséré et signalé.
Peut-on empêcher l’export des variables secrètes ?
Gardez le masquage actif pour remplacer les valeurs secret ou celles dont le nom est sensible par [REDACTED]. Cela contrôle cette sortie, sans modifier les droits d’export de Postman. Les secrets enfouis dans du texte arbitraire ne sont pas tous détectables.
L’export d’une collection inclut-il toutes les variables d’environnement ?
Non. Exportez l’environnement séparément et choisissez Environnement → .env. Seules les valeurs actives contenues dans ce fichier sont traitées. Les valeurs locales, globales ou Vault absentes du fichier ne sont pas récupérées.
Un résultat inattendu avec votre document ?
Commencer par quelques appels
Utilisez Postman vers OpenAPI sur une petite collection, comparez la liste et le rapport au fichier original, puis complétez les emplacements non résolus avant d’enregistrer le résultat.