Tutoriel Postman - Comment utiliser pour les tests d'API ?

Qu'est-ce que le facteur ?

Facteur est un outil de test d'API évolutif qui s'intègre rapidement dans le pipeline CI/CD. Il a commencé en 2012 en tant que projet parallèle d'Abhinav Asthana pour simplifier le flux de travail des API dans les tests et le développement. API signifie Application Programming Interface qui permet aux applications logicielles de communiquer entre elles via des appels API.

Pourquoi utiliser Postman ?

Avec plus de 4 millions d'utilisateurs aujourd'hui, Postman Software est devenu un outil de choix pour leswing les raisons:

  1. Accessibilité - Pour utiliser l'outil Postman, il suffit de se connecter à son propre compte, ce qui facilite l'accès aux fichiers à tout moment et en tout lieu tant qu'une application Postman est installée sur l'ordinateur.
  2. Utilisation des collections - Postman permet aux utilisateurs de créer des collections pour leurs appels API Postman. Chaque collection peut créer des sous-dossiers et plusieurs requêtes. Cela aide à organiser vos suites de tests.
  3. Collaboration – Les collections et les environnements peuvent être importés ou exportés, ce qui facilite le partage de fichiers. Un lien direct peut également être utilisé pour partager des collections.
  4. Création d'environnements - Avoir plusieurs environnements aide à réduire la répétition des tests car on peut utiliser la même collection mais pour un environnement différent. C'est là que se déroulera la paramétrisation dont nous parlerons dans d'autres leçons.
  5. Création de tests - Des points de contrôle de test tels que la vérification de l'état de réponse HTTP réussi peuvent être ajoutés à chaque appel d'API Postman, ce qui permet de garantir Couverture de test.
  6. Tests d'automatisation - Grâce à l'utilisation de Collection Runner ou de Newman, les tests peuvent être exécutés en plusieurs itérations, ce qui permet de gagner du temps pour les tests répétitifs.
  7. Débogage - La console Postman permet de vérifier quelles données ont été récupérées, ce qui facilite le débogage des tests.
  8. Intégration continue – Grâce à sa capacité à soutenir l'intégration continue, les pratiques de développement sont maintenues.

Comment utiliser Postman pour exécuter des API

Ci-dessous se trouve l'espace de travail Postman. Explorons le processus étape par étape sur Comment utiliser le facteur et différentes fonctionnalités de l'outil Postman !

Comment utiliser Postman pour exécuter des API

  1. Nouveau - C'est ici que vous allez créer une nouvelle demande, collection ou environnement.
  2. Importer – Ceci est utilisé pour importer une collection ou un environnement. Il existe des options telles que l'importation à partir d'un fichier, d'un dossier, d'un lien ou du collage de texte brut.
  3. Runner - Les tests d'automatisation peuvent être exécutés via le Collection Runner. Ceci sera discuté plus en détail dans la prochaine leçon.
  4. Ouvrir nouveau – Ouvrez un nouvel onglet, Postman Window ou Runner Window en cliquant sur ce bouton.
  5. Mon espace de travail – Vous pouvez créer un nouvel espace de travail individuellement ou en équipe.
  6. Inviter – Collaborez sur un espace de travail en invitant les membres de l'équipe.
  7. Historique - Les demandes passées que vous avez envoyées seront affichées dans l'historique. Cela facilite le suivi des actions que vous avez effectuées.
  8. Collections – Organisez votre suite de tests en créant des collections. Chaque collection peut avoir des sous-dossiers et plusieurs requêtes. Une demande ou un dossier peut également être dupliqué.
  9. Onglet Demande – Ceci affiche le titre de la demande sur laquelle vous travaillez. Par défaut, "Demande sans titre" serait affiché pour les demandes sans titre.
  10. Requête HTTP - Cliquer dessus afficherait une liste déroulante de différentes requêtes telles que GET, POST, COPY, DELETE, etc. Dans les tests de l'API Postman, les requêtes les plus couramment utilisées sont GET et POST.
  11. URL de la demande - Aussi connu sous le nom de point de terminaison, c'est là que vous identifierez le lien avec lequel l'API communiquera.
  12. Enregistrer - S'il y a des modifications à une demande, il est indispensable de cliquer sur Enregistrer pour que les nouvelles modifications ne soient pas perdues ou écrasées.
  13. Params - C'est ici que vous écrivez les paramètres nécessaires à une demande, tels que les valeurs de clé.
  14. Autorisation – Pour accéder aux API, une autorisation appropriée est nécessaire. Il peut se présenter sous la forme d'un nom d'utilisateur et d'un mot de passe, d'un jeton porteur, etc.
  15. En-têtes – Vous pouvez définir des en-têtes tels que le type de contenu JSON en fonction des besoins de l'organisation.
  16. Corps – C'est ici que l'on peut personnaliser letails dans une requête couramment utilisée dans les requêtes POST.
  17. Script de pré-demande - Ce sont des scripts qui seront exécutés avant la demande. Généralement, les scripts de pré-demande pour l'environnement de configuration sont utilisés pour garantir que les tests seront exécutés dans l'environnement correct.
  18. Tests – Ce sont des scripts exécutés lors de la requête. Il est important d'avoir des tests car il met en place des points de contrôle pour vérifier si l'état de la réponse est correct, les données récupérées sont comme prévu et d'autres tests.

Utilisation des requêtes GET

Les requêtes Get sont utilisées pour récupérer des informations à partir de l'URL donnée. Aucune modification ne sera apportée au point de terminaison.

Nous utiliserons le suivantwing URL pour tous les exemples de ce tutoriel Postman https://jsonplaceholder.typicode.com/users

Dans l'espace de travail

  1. Définissez votre requête HTTP sur GET.
  2. Dans le champ URL de la demande, saisissez le lien
  3. Cliquez sur Envoyer
  4. Vous verrez 200 Message OK
  5. Il devrait y avoir 10 résultats utilisateur dans le corps, ce qui indique que votre test s'est déroulé avec succès.

Utilisation des requêtes Get

* Remarque: Il peut arriver que la demande Get Postman échoue. Cela peut être dû à une URL de demande non valide ou à une authentification nécessaire.

Travailler avec les requêtes POST

Les demandes de publication sont différentes de la demande Get car il y a une manipulation des données avec l'utilisateur ajoutant des données au point de terminaison. En utilisant les mêmes données du didacticiel précédent dans Get request, ajoutons maintenant notre propre utilisateur.

Étape 1) Cliquez sur un nouvel onglet pour créer une nouvelle demande.

Travailler avec les demandes de publication

Étape 2) Dans le nouvel onglet

  1. Définissez votre requête HTTP sur POST.
  2. Saisissez le même lien dans l'URL de la demande : https://jsonplaceholder.typicode.com/users
  3. passer à l'onglet Corps

Travailler avec les demandes de publication

Étape 3) Dans le corps,

  1. Cliquez sur brut
  2. Sélectionnez JSON

Travailler avec les demandes de publication

Étape 4) Copiez et collez un seul résultat utilisateur de la demande d'obtention précédente comme ci-dessous. Assurez-vous que le code a été copié correctement avec des accolades et des crochets appariés. Remplacez l'identifiant par 11 et le nom par le nom de votre choix. Vous pouvez également modifier d'autres details comme l'adresse.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "Sincere@april.biz",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]

Travailler avec les demandes de publication

* Remarque: La demande de publication en ligne doit avoir le format correct pour garantir que les données demandées seront créées. Il est recommandé d'utiliser Get first pour vérifier le format JSON de la requête. Vous pouvez utiliser des outils comme https://jsonformatter.curiousconcept.com/

Travailler avec les demandes de publication

Étape 5) Ensuite,

  1. Cliquez sur Envoyer.
  2. Statut : 201 créé doit être affiché
  3. Les données publiées sont affichéeswing dans le corps.

Travailler avec les demandes de publication

Comment paramétrer les requêtes

Le paramétrage des données est l'une des fonctionnalités les plus utiles de Postman. Au lieu de créer les mêmes requêtes avec des données différentes, vous pouvez utiliser des variables avec des paramètres. Ces données peuvent provenir d'un fichier de données ou d'une variable d'environnement. Le paramétrage permet d'éviter la répétition des mêmes tests et les itérations peuvent être utilisées pour tests d'automatisation.

Les paramètres sont créés à l'aide de doubles accolades : {{sample}}. Examinons un exemple d'utilisation de paramètres dans notre requête précédente :

Paramétrer les requêtes

Créons maintenant une requête get de paramétrage.

Étape 1)

  1. Définissez votre requête HTTP sur GET
  2. Saisissez ce lien : https://jsonplaceholder.typicode.com/users. Remplacez la première partie du lien par un paramètre tel que {{url}}. L'URL de la requête doit maintenant être {{url}}/users.
  3. Cliquez sur envoyer.

Il ne devrait y avoir aucune réponse puisque nous n'avons pas défini la source de notre paramètre.

Paramétrer les requêtes

Étape 2) Pour utiliser le paramètre, vous devez définir l'environnement

  1. Cliquez sur l'icône de l'œil
  2. Cliquez sur modifier pour définir la variable sur un environnement global qui peut être utilisé dans toutes les collections.

Paramétrer les requêtes

Étape 3) En variables,

  1. définissez le nom sur l'url qui est https://jsonplaceholder.typicode.com
  2. cliquez sur Enregistrer.

Paramétrer les requêtes

Étape 4) Cliquez sur Fermer si vous voyez l'écran suivant

Paramétrer les requêtes

Étape 5) Revenez à votre demande Get puis cliquez sur envoyer. Il devrait maintenant y avoir des résultats pour votre demande.

Paramétrer les requêtes

* Remarque: Assurez-vous toujours que vos paramètres ont une source telle qu'une variable d'environnement ou un fichier de données pour éviter les erreurs.

Comment créer des tests Postman

Les tests Postman sont des codes JavaScript ajoutés aux requêtes qui vous aident à vérifier les résultats tels que le statut de réussite ou d'échec, la comparaison des résultats attendus, etc. Il commence généralement par pm.test. Il peut être comparé aux assertions, vérifier les commandes disponibles dans d'autres outils.

Faisons quelques bases Test d'API en utilisant Postman pour nos requêtes de paramétrage de la leçon précédente.

Étape 1) Accédez à votre demande d'utilisateur GET du didacticiel précédent.

  1. Passez à l'onglet des tests. Sur le côté droit se trouvent des codes d'extrait de code.
  2. Dans la section des extraits, cliquez sur "Code d'état : le code est 200".

Le volet est rempli automatiquement

Créer des tests Postman

Étape 2) Cliquez maintenant sur Envoyer. Le résultat du test devrait maintenant s'afficher.

Créer des tests Postman

Étape 3) Revenez à l'onglet test et ajoutons un autre test. Cette fois, nous allons comparer le résultat attendu au résultat réel.

Dans la section des extraits, cliquez sur "Response body: JSON value check". Nous vérifierons si Leanne Graham a l'ID utilisateur 1.

Créer des tests Postman

Étape 4)

  1. Remplacez "Votre nom de test" dans le code par "Vérifiez si l'utilisateur avec id1 est Leanne Graham" afin que le nom du test spécifie exactement ce que nous voulons tester.
  2. Remplacez jsonData.value par jsonData[0].name. Pour obtenir le chemin, vérifiez le corps dans Obtenir le résultat plus tôt. Puisque Leanne Graham est l'ID utilisateur 1, jsonData est dans le premier résultat qui doit commencer par 0. Si vous voulez obtenir le deuxième résultat, utilisez jsonData[1] et ainsi de suite pour les résultats suivants.
  3. Dans eql, entrez "Leanne Graham"
pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

Créer des tests Postman

Étape 5) Cliquez sur envoyer. Il devrait maintenant y avoir deux résultats de test réussis pour votre demande.

Créer des tests Postman

* Remarque: Il existe différents types de tests qui peuvent être créés dans Postman. Essayez d'explorer l'outil et voyez quels tests répondront à vos besoins.

Comment créer des collections

Les collections jouent un rôle important dans l'organisation des suites de tests. Il peut être importé et exporté, ce qui facilite le partage des collections au sein de l'équipe. Dans ce tutoriel, nous allons apprendre à créer et exécuter une collection.

Commençons par créer une collection :

Étape 1) Cliquez sur le bouton Nouveau dans le coin supérieur gauche de la page.

Créer des collections

Étape 2) Sélectionnez Collecte. La fenêtre Créer une collection devrait apparaître.

Créer des collections

Étape 3) Saisissez le nom et la description de la collection souhaitée, puis cliquez sur Créer. Une collection devrait maintenant être créée.

Créer des collections

Étape 4) Revenez à la requête Get précédente. Cliquez sur Enregistrer

Créer des collections

Étape 5)

  1. Sélectionnez Collection de tests Postman.
  2. Cliquez sur Enregistrer dans la collection de tests Postman

Créer des collections

Étape 6) La collection de test Postman devrait maintenant contenir une requête.

Créer des collections

Étape 7) Répétez les étapes 4 et 5 pour la requête Post précédente afin que la collection ait désormais deux requêtes.

Créer des collections

Comment exécuter des collections à l'aide de Collection Runner

Il existe deux façons de gérer une collection, à savoir Collection Runner et Newman. Commençons par exécuter la collection dans Collection Runner.

Étape 1) Cliquez sur le bouton Runner situé en haut de la page à côté du bouton Importer.

Exécuter des collections à l'aide de Collection Runner

Étape 2) La page Collection Runner devrait apparaître comme ci-dessous. Suivrewing est la description de divers champs

Exécuter des collections à l'aide de Collection Runner

Étape 3) Exécutez votre collection de tests Postman en configurant le suiviwing:

  • Choisissez la collection de tests Postman - Définissez les itérations sur 3
  • Définir le délai sur 2500 ms
  • Cliquez sur le bouton Exécuter le test Postman…

Exécuter des collections à l'aide de Collection Runner

Étape 4) La page des résultats d'exécution doit s'afficher après avoir cliqué sur le bouton Exécuter. En fonction du délai, vous devriez voir les tests au fur et à mesure qu'ils s'exécutent.

  1. Une fois les tests terminés, vous pouvez voir l'état du test s'il est réussi ou échoué et les résultats par itération.
  2. Vous voyez le statut Pass pour les demandes d'obtention
  3. Étant donné que nous n'avons pas eu de tests pour Post, il devrait y avoir un message indiquant que la demande n'a pas eu de tests.

Exécuter des collections à l'aide de Collection Runner

Vous pouvez voir à quel point il est important qu'il y ait des tests dans vos requêtes afin que vous puissiez vérifier l'état de la requête HTTP en cas de succès et que les données soient créées ou récupérées.

Comment exécuter des collections à l'aide de Newman

Une autre façon de gérer une collection est via Newman. Les principales différences entre Newman et Collection Runner sont les suivanteswing:

  1. Newman est un module complémentaire pour Postman. Vous devrez l'installer séparément de l'application native.
  2. Newman utilise la ligne de commande tandis que Collection Runner a une interface graphique.
  3. Newman peut être utilisé pour l'intégration continue.

Pour installer Newman et exécuter notre collection à partir de celui-ci, procédez comme suitwing:

Étape 1) Installez nodejs en utilisant ce lien : http://nodejs.org/download/

Étape 2) Ouvrez la ligne de commande et entrez

 npm install -g newman

Newman devrait maintenant être installé sur votre ordinateur.

Exécuter des collections à l'aide de Newman

Étape 3) Une fois Newman installé, revenons à notre espace de travail Postman.Dans les Collections box, cliquez sur les trois points. Les options devraient maintenant apparaître. Sélectionnez Exporter.

Exécuter des collections à l'aide de Newman

Étape 4) Choisissez Exporter la collection en tant que collection v2.1 (recommandé) puis cliquez sur Exporter.

Exécuter des collections à l'aide de Newman

Étape 5) Sélectionnez l'emplacement souhaité, puis cliquez sur Enregistrer. Il est conseillé de créer un dossier spécifique pour vos tests Postman. Une collection doit maintenant être exportée vers le répertoire local de votre choix.

Étape 6) Nous devrons également exporter notre environnement. Cliquez sur l'icône en forme d'œil à côté de la liste déroulante de l'environnement dans Global, sélectionnez Télécharger en tant que JSON. Sélectionnez l'emplacement souhaité, puis cliquez sur Enregistrer. Il est conseillé que l'environnement soit dans le même dossier que votre collection.

Exécuter des collections à l'aide de Newman

Étape 7) L'environnement doit maintenant être exporté vers le même répertoire local que Collection.

Étape 8) Revenez maintenant à la ligne de commande et modifiez le répertoire dans lequel vous avez enregistré la collection et l'environnement.

 cd C:\Users\Asus\Desktop\Postman Tutorial

Étape 9) Exécutez votre collection à l'aide de cette commande :

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Les résultats d'exécution devraient maintenant apparaître comme ci-dessous.

Exécuter des collections à l'aide de Newman

Pour guide est une référence à certains codes Newman de base pour l'exécution :

  1. Exécutez une collecte uniquement. Cela peut être utilisé s'il n'y a pas de dépendance d'environnement ou de fichier de données de test.
  2. newman run <collection name>
  3. Exécutez une collection et un environnement. L'indicateur -e est pour l'environnement.
  4. newman run <collection name> -e <environment name>
  5. Exécutez une collecte avec le numéro souhaité. d'itérations.
  6. newman run <collection name> -n <no.of iterations>
  7. Exécuter avec le fichier de données.
  8. newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>
  9. Réglez le délai. Ceci est important car les tests peuvent échouer s'ils sont exécutés sans délai en raison de demandes lancées sans que la demande précédente n'ait terminé le traitement sur le serveur d'extrémité.
newman run <collection name> -d <delay time>

Nos programmes Guide des questions d'entrevue du facteur vous aidera à réussir l'entretien et vous aidera à obtenir l'emploi de vos rêves pour les tests de logiciels.

Résumé

  • Test d'API à l'aide de Postman : Postman est une application de test d'API. Postman est l'un des outils les plus populaires utilisés dans les tests d'API en envoyant des requêtes au serveur Web et en obtenant la réponse.
  • Accessibilité, utilisation des collections, collaboration, intégration continue, sont quelques-unes des fonctionnalités clés à apprendre dans Postman
  • Il est recommandé de créer un compte dans Postman, afin que vos collections soient disponibles en ligne
  • Vous pouvez paramétrer la demande dans Postman
  • Vous pouvez créer des tests pour vérifier une demande du facteur
  • Les collections peuvent être exécutées à l'aide de Newman ou Collection Runner