Comment définir des variables dans le script de requête Postman Post

Les tests d'API efficaces nécessitent la gestion dynamique des données. Les scripts de post-requête de Postman offrent un mécanisme robuste pour y parvenir grâce aux paramètres de variables. En capturant et en stockant stratégiquement les valeurs des réponses d'API, les testeurs peuvent améliorer l'efficacité, la maintenabilité et la fiabilité des tests.

Cet article explore les subtilités de l'utilisation des capacités de script de Postman pour définir des variables. Il fournira des conseils complets sur l'utilisation des fonctions pm.environment.set() et pm.globals.set() pour créer et gérer des variables dans différents contextes. Des exemples pratiques illustreront comment extraire des données des réponses d'API et les affecter à des variables pour une utilisation ultérieure dans les cas de test.

Que sont les scripts de post-requête ?

Les scripts de post-requête sont des extraits de code JavaScript qui s'exécutent après que Postman a envoyé une requête et reçu une réponse. Ils offrent un moyen puissant d'interagir avec les données de réponse, d'effectuer des assertions, d'extraire des informations et de manipuler des données pour les requêtes ultérieures.

Essentiellement, ils vous permettent d'automatiser diverses tâches de test et de traitement des données dans l'environnement Postman.

Guide étape par étape sur la façon de définir une variable dans le script de post-requête Postman

Étape 1 - Accéder à l'onglet Script de post-requête :

Tout d'abord, ouvrez l'API ou la requête que vous souhaitez modifier et cliquez sur l'onglet Scripts. C'est là que vous pouvez trouver la section Post-response.

Étape 2 - Extraire les données de la réponse Postman

Utilisez les méthodes pm.response.json() ou pm.response.text() pour accéder au corps de la réponse de l'API sous forme de JSON ou de texte, respectivement.

Au cours de cette étape, vous devez également employer toutes les techniques de manipulation d'objets ou de chaînes JavaScript nécessaires pour extraire les données souhaitées.

Étape 3 - Définir la variable

Vous devez utiliser pm.environment.set(), pm.globals.set() ou pm.collectionVariables.set() pour stocker les données extraites dans une variable. Le choix dépend de la portée souhaitée.

Exemple de définition d'une variable dans le script de post-requête de Postman

pm.test("Définir une variable", () => {
    const jsonData = pm.response.json();
    const token = jsonData.access_token;
    pm.environment.set("auth_token", token);
});

Cet extrait de code extrait le access_token de la réponse JSON et le stocke dans une variable d'environnement nommée auth_token.

Conseils supplémentaires

• Gestion des erreurs : Mettez en œuvre la gestion des erreurs pour gérer en douceur les formats de réponse inattendus ou les données manquantes.
• Types de données : Assurez-vous des types de données corrects pour les variables. Utilisez l'opérateur typeof pour vérifier.
• Utilisation des variables : Accédez aux variables dans les requêtes ultérieures à l'aide de doubles accolades : {{auth_token}}.
• Meilleures pratiques : Envisagez d'utiliser des noms de variables descriptifs et d'organiser vos scripts pour une meilleure lisibilité.

Avantages de la définition de variables dans les scripts de post-requête Postman

Données de test dynamiques

Données en temps réel : Capturez et stockez des données dynamiques à partir des réponses d'API (par exemple, ID, jetons, horodatages) pour une utilisation immédiate dans les requêtes ultérieures.

Tests basés sur les données : Créez des tests plus robustes en utilisant les données réelles du système plutôt que des valeurs statiques.

Réutilisation des données de test

Efficacité : Réutilisez les données capturées dans plusieurs requêtes au sein d'une collection ou d'un environnement, ce qui réduit la saisie manuelle des données et les erreurs potentielles.

Corrélation : Liez les requêtes dépendantes en transmettant les données d'une réponse à une autre, améliorant ainsi la précision des tests.

Maintenance des tests

Flexibilité : Modifiez facilement les valeurs des variables sans modifier plusieurs corps de requête, ce qui rend les mises à jour des tests plus efficaces.

Centralisation : Gérez les données de test dans un emplacement centralisé (variables d'environnement ou globales) pour une meilleure organisation.

Scénarios de test complexes

Manipulation des données : Traitez et transformez les données capturées avant de les stocker en tant que variable, ce qui permet une logique de test complexe.

Logique conditionnelle : Utilisez des variables dans des instructions conditionnelles pour contrôler le flux des tests en fonction des données de réponse.

Collaboration

Données partagées : Partagez des variables d'environnement ou globales entre les membres de l'équipe pour maintenir des données de test cohérentes.

Gestion de l'environnement : Créez différents environnements avec des valeurs de variables variables pour différents scénarios de test.

Cas d'utilisation courants pour la définition de variables dans les scripts de post-requête Postman

La définition de variables dans les scripts de post-requête Postman est une technique polyvalente avec de nombreuses applications dans les tests d'API. Voici quelques cas d'utilisation courants :

• Gestion des jetons d'authentification : Extrayez les jetons d'accès des réponses d'authentification et stockez-les pour les requêtes ultérieures.
• Gestion dynamique des données : Capturez et stockez des données dynamiques telles que les ID d'utilisateur, les numéros de commande ou les ID de session pour la corrélation des données de test.
• Tests basés sur les données : Générez des données de test dynamiquement et stockez-les dans des variables pour des tests itératifs.
• Gestion des erreurs : Stockez les messages d'erreur ou les codes pour une analyse ou un rapport plus approfondis.
• Tests de performance : Mesurez les temps de réponse et stockez-les pour analyse.
• Chaînage des requêtes : Transmettez des données d'une requête à une autre, créant ainsi des flux de test complexes.
• Gestion de l'environnement : Stockez des valeurs de configuration spécifiques à l'environnement, telles que les URL de base ou les clés d'API.
• Génération de données de test : Créez des données aléatoires ou séquentielles pour les cas de test.
• Logique personnalisée : Mettez en œuvre une logique personnalisée basée sur les données de réponse, telles que l'exécution conditionnelle ou les transformations de données.

Apidog - Un outil de développement d'API tout-en-un

Apidog est un outil d'API complet qui offre aux utilisateurs des fonctionnalités complètes pour l'ensemble du cycle de vie de l'API. Il se spécialise dans une interface utilisateur simple et intuitive qui favorise une approche de développement axée sur la conception.

Créez des scripts de post-processeur en quelques secondes

Avec Apidog, vous pouvez implémenter un post-processeur de la manière que vous souhaitez.

Vous pouvez choisir parmi une variété de post-processeurs, tels que des assertions, des scripts personnalisés et même publics.

Importer d'autres API vers Apidog

Apidog prend en charge divers types de fichiers API, notamment OpenAPI (ou Swagger), Postman et Insomnia. De cette façon, vous pouvez importer des projets existants dans l'environnement de développement élégant d'Apidog pour d'autres modifications !

Tout d'abord, ouvrez la section Paramètres de votre projet et recherchez le bouton Importer des données sous Gestion des données. Si vous ne trouvez pas le type de fichier que vous souhaitez importer, ne vous inquiétez pas ! Il suffit de faire glisser et de déposer le fichier dans la partie inférieure de l'écran.

Conclusion

En maîtrisant l'art de la définition de variables dans les scripts de post-requête de Postman, vous avez déverrouillé un outil puissant pour optimiser votre flux de travail de test d'API. La possibilité de capturer et de stocker dynamiquement les données des réponses vous permet de créer des suites de tests plus robustes, efficaces et maintenables. Grâce à une considération attentive des portées des variables et à des techniques efficaces d'extraction des données, vous pouvez améliorer considérablement vos capacités de test et accélérer les cycles de développement.

N'oubliez pas que la clé du succès réside dans la compréhension du comportement de votre API, la planification stratégique de vos cas de test et l'exploitation de tout le potentiel des fonctionnalités de script de Postman. En suivant les conseils fournis dans cet article, vous serez bien équipé pour exploiter la puissance des variables et élever vos tests d'API vers de nouveaux sommets.