Test des API Web avec les collections Postman

1. Introduction

Pour tester en profondeur une API Web, nous avons besoin d'une sorte de client Web pour accéder aux points de terminaison de l'API. Postman est un outil autonome qui exerce les API Web en effectuant des requêtes HTTP depuis l'extérieur du service .

Lorsque vous utilisez Postman, nous n'avons pas besoin d'écrire de code d'infrastructure client HTTP juste pour le plaisir de tester. Au lieu de cela, nous créons des suites de tests appelées collections et laissons Postman interagir avec notre API.

Dans ce didacticiel, nous verrons comment créer une collection Postman capable de tester une API REST.

2. Configuration

Avant de commencer avec notre collection, nous devons configurer l'environnement.

2.1. Installer Postman

Postman est disponible pour Linux, Mac et Windows. L'outil peut être téléchargé et installé à partir du site Web Postman.

Après avoir fermé l'écran de démarrage, nous pouvons voir l'interface utilisateur:

2.2. Exécution du serveur

Postman a besoin d'un serveur HTTP en direct pour traiter ses requêtes . Pour ce tutoriel, nous utiliserons un précédent projet Baeldung, spring-boot-rest, disponible sur GitHub.

Comme on peut le deviner d'après le titre, spring-boot-rest est une application Spring Boot. Nous construisons l'application avec l' installation de l' objectif Maven . Une fois construit, nous lançons le serveur avec l'objectif Maven personnalisé spring-boot: run .

Pour vérifier que le serveur fonctionne, nous pouvons frapper cette URL dans notre navigateur:

//localhost:8082/spring-boot-rest/auth/foos

Ce service utilise une base de données en mémoire. Tous les enregistrements sont effacés lorsque le serveur est arrêté.

3. Création d'une collection de facteur

Une collection dans Postman est une série de requêtes HTTP. Postman enregistre tous les aspects des demandes, y compris les en-têtes et les corps de message. Par conséquent, nous pouvons exécuter les requêtes en séquence sous forme de tests semi-automatisés .

Commençons par créer une nouvelle collection. Nous pouvons cliquer sur la flèche déroulante du bouton Nouveau et sélectionner Collection :

Lorsque la boîte de dialogue CRÉER UNE NOUVELLE COLLECTION apparaît, nous pouvons nommer notre collection « test API toto ». Enfin, nous cliquons sur le bouton Créer pour voir notre nouvelle collection apparaître dans la liste à gauche:

Une fois notre collection créée, nous pouvons passer le curseur dessus pour révéler deux boutons de menu. Le bouton fléché ouvre un panneau déroulant à droite qui permet d'accéder à Collection Runner . Inversement, le bouton points de suspension ouvre un menu déroulant contenant un certain nombre d'opérations sur la collection.

4. Ajout d'une requête POST

4.1. Créer une nouvelle demande

Maintenant que nous avons une collection vide, ajoutons une requête qui atteint notre API. Plus précisément, envoyons un message POST à ​​l'URI / auth / foos. Pour ce faire, nous ouvrons le menu points de suspension sur notre collection et sélectionnons Ajouter une demande.

Lorsque la boîte de dialogue SAVE REQUEST apparaît, fournissons un nom descriptif, tel que « ajouter un toto». Ensuite, cliquez sur le bouton Enregistrer pour test API foo .

Une fois la requête créée, nous pouvons voir que notre collection indique une requête . Cependant, si notre collection n'a pas été étendue, nous ne pouvons pas encore voir la demande. Dans ce cas, nous pouvons cliquer sur la collection pour la développer.

Maintenant, nous devrions voir la nouvelle demande répertoriée sous notre collection. Nous pouvons observer que la nouvelle requête, par défaut, est un HTTP GET, ce qui n'est pas ce que nous voulons. Nous corrigerons cela dans la section suivante:

4.2. Modifier la demande

Pour éditer la requête, cliquons dessus, chargeant ainsi la requête dans l'onglet de l'éditeur de requête:

Bien que l'éditeur de requêtes propose de nombreuses options, nous n'en avons besoin que de quelques-unes pour le moment.

Tout d'abord, utilisons la liste déroulante pour changer la méthode de GET à POST.

Deuxièmement, nous avons besoin d'une URL. À droite de la liste déroulante de la méthode se trouve une zone de texte pour l'URL de la demande. Alors, entrons cela maintenant:

//localhost:8082/spring-boot-rest/auth/foos

La dernière étape consiste à fournir un corps de message. Sous l'adresse URL se trouve une rangée d'en-têtes d'onglets. Nous cliquons sur l'en- tête de l'onglet Corps pour accéder à l'éditeur de corps.

Dans l' onglet Corps , juste au-dessus de la zone de texte, il y a une rangée de boutons radio et une liste déroulante. Ceux-ci contrôlent le formatage et le type de contenu de la demande.

Notre service accepte les données JSON, nous sélectionnons donc le bouton radio brut . Dans la liste déroulante à droite, nous appliquons le type de contenu JSON (application / json) .

Une fois le codage et le type de contenu définis, nous ajoutons notre contenu JSON à la zone de texte:

{ "name": "Transformers" }

Enfin, assurons-nous de sauvegarder nos modifications en appuyant sur Ctrl-S ou en appuyant sur le bouton Enregistrer . Le bouton Enregistrer se trouve à droite du bouton Envoyer . Une fois que nous avons sauvegardé, nous pouvons voir que la requête a été mise à jour en POST dans la liste de gauche:

5. Exécution de la demande

5.1. Exécuter une seule demande

To run a single request, we just click the Send button to the right of the URL address. Once we click Send, the response panel will open below the request panel. It may be necessary to scroll down to see it:

Let's examine our results. Specifically, in the header bar, we see that our request succeeded with the status 201 Created. Furthermore, the response body shows that our Transformers record received an id of 1.

5.2. Using the Collection Runner

In contrast to the Send button, the collection runner can execute an entire collection. To launch the collection runner, we hover the cursor over our foo API test collection and click the pull-right arrow. In the pull-right panel we can see a Run button, so let's click that:

When we click the Run button the collection runner opens in a new window. Because we launched it from our collection, the runner is already initialized to our collection:

The collection runner offers options that affect the test run, but we won't need them for this exercise. Let's go directly to the Run foo API test button at the bottom and click that.

When we run the collection, the view changes to Run Results. In this view, we see a list of tests that are marked green for success and red for failure.

Even though our request was sent, the runner indicates that zero tests passed and zero tests failed. This is because we haven't added tests to our request yet:

6. Testing the Response

6.1. Adding Tests to a Request

To create a test, let's return to the request editing panel where we built our POST method. We click the Tests tab which is located under the URL. When we do that, the Tests panel appears:

In the Tests panel, we write JavaScript that will be executed when the response is received from the server.

Postman offers built-in variables that provide access to the request and response. Furthermore, a number of JavaScript libraries can be imported using the require() syntax.

There are far too many scripting features to cover in this tutorial. However, the official Postman documentation is an excellent resource on this topic.

Let's continue by adding three tests to our request:

pm.test("success status", () => pm.response.to.be.success ); pm.test("name is correct", () => pm.expect(pm.response.json().name).to.equal("Transformers")); pm.test("id was assigned", () => pm.expect(pm.response.json().id).to.be.not.null );

As we can see, these tests make use of the global pm module provided by Postman. In particular, the tests use pm.test(), pm.expect(), and pm.response.

The pm.test() function accepts a label and an assertion function, such as expect(). We're using pm.expect() to assert conditions on the contents of the response JSON.

The pm.response object provides access to various properties and operations on the response returned from the server. Available properties include the response status and JSON content, among others.

As always, we save our changes with Ctrl-S or the Save button.

6.2. Running the Tests

Now that we have our tests, let's run the request again. Pressing the Send button displays the results in the Test Results tab of the response panel:

Likewise, the collection runner now displays our test results. Specifically, the summary at the top left shows the updated passed and failed totals. Below the summary is a list that shows each test with its status:

6.3. Viewing the Postman Console

The Postman Console is a useful tool for creating and debugging scripts. We can find the console under the View menu with the item name Show Postman Console. When launched, the console opens in a new window.

While the console is open, it records all HTTP requests and responses. Furthermore, when scripts use console.log(), the Postman Console displays those messages:

7. Creating a Sequence of Requests

So far, we've focused on a single HTTP request. Now, let's see what we can do with multiple requests. By chaining together a series of requests, we can simulate and test a client-server workflow.

In this section, let's apply what we've learned in order to create a sequence of requests. Specifically, we'll add three more requests to execute after the POST request we have already created. These will be a GET, a DELETE, and finally, another GET.

7.1. Capturing Response Values in Variables

Before we create our new requests, let's make a modification to our existing POST request. Because we don't know which id the server will assign each foo instance, we can use a variable to capture the id returned by the server.

To capture that id, we'll add one more line to the end of the POST request's test script:

pm.variables.set("id", pm.response.json().id);

The pm.variables.set() function takes a value and assigns it to a temporary variable. In this case, we're creating an id variable to store our object's id value. Once set, we can access this variable in later requests.

7.2. Adding a GET Request

Now, using the techniques from previous sections, let's add a GET request after the POST request.

With this GET request, we'll retrieve the same foo instance that the POST request created. Let's name this GET request as “get a foo“.

The URL of the GET request is:

//localhost:8082/spring-boot-rest/auth/foos/{{id}}

In this URL, we're referencing the id variable that we previously set during the POST request. Thus, the GET request should retrieve the same instance that was created by the POST.

Variables, when appearing outside of scripts, are referenced using the double-brace syntax {{id}}.

Since there's no body for a GET request, let's proceed directly to the Tests tab. Because the tests are similar, we can copy the tests from the POST request, then make a few changes.

Firstly, we don't need to set the id variable again, so let's not copy that line.

Secondly, we know which id to expect this time, so let's verify that id. We can use the id variable to do that:

pm.test("success status", () => pm.response.to.be.success ); pm.test("name is correct", () => pm.expect(pm.response.json().name).to.equal("Transformers")); pm.test("id is correct", () => pm.expect(pm.response.json().id).to.equal(pm.variables.get("id")) );

Since the double-brace syntax is not valid JavaScript, we use the pm.variables.get() function to access the id variable.

Finally, let's save the changes as we've done before.

7.3. Adding a DELETE Request

Next, we'll add a DELETE request that will remove the foo object from the server.

We'll proceed by adding a new request after the GET, and setting its method to DELETE. We can name this request “delete a foo“.

The URL of the delete is identical to the GET URL:

//localhost:8082/spring-boot-rest/auth/foos/{{id}}

The response will not have a body to test, but we can test the response code. Therefore, the DELETE request will have only one test:

pm.test("success status", () => pm.response.to.be.success );

7.4. Verifying the DELETE

Finally, let's add another copy of the GET request to verify that the DELETE really worked. This time, let's duplicate our first GET request instead of creating a request from scratch.

To duplicate a request, we right-click on the request to show the dropdown menu. Then, we select Duplicate.

The duplicate request will have the word Copy appended to its name. Let's rename it to “verify delete” to avoid confusion. The Rename option is available by right-clicking the request.

By default, the duplicate request appears immediately after the original request. As a result, we'll need to drag it below the DELETE request.

The final step is to modify the tests. However, before we do that, let's take an opportunity to see a failed test.

We have copied the GET request and moved it after the DELETE, but we haven't updated the tests yet. Since the DELETE request should have deleted the object, the tests should fail.

Let's make sure to save all of our requests, then hit Retry in the collection runner. As expected, our tests have failed:

Now that our brief detour is complete, let's fix the tests.

By reviewing the failed tests, we can see that the server responds with a 500 status. Therefore, we'll change the status in our test.

Furthermore, by viewing the failed response in the Postman Console, we learn that the response includes a cause property. Moreover, the cause property contains the string “No value present“. We can test for that as well:

pm.test("status is 500", () => pm.response.to.have.status(500) ); pm.test("no value present", () => pm.expect(pm.response.json().cause).to.equal("No value present"));

7.5. Running the Full Collection

Now that we've added all of the requests, let's run the full collection in the collection runner:

If everything has gone according to plan, we should have nine successful tests.

8. Exporting and Importing the Collection

While Postman stores our collections in a private, local location, we may want to share the collection. To do that, we export the collection to a JSON file.

The Export command is available within the ellipsis menu of the collection. When prompted for a JSON file version, let's choose the latest recommended version.

After we select the file version, Postman will prompt for a file name and location for the exported collection. We can choose a folder within our GitHub project, for example.

To import a previously exported collection, we use the Import button. We can find it in the toolbar of the main Postman window. When Postman prompts for a file location, we can navigate to the JSON file we wish to import.

It's worth noting that Postman does not track exported files. As a result, Postman doesn't show external changes until we re-import the collection.

9. Conclusion

Dans cet article, nous avons utilisé Postman pour créer des tests semi-automatisés pour une API REST. Bien que cet article serve d'introduction aux fonctionnalités de base de Postman, nous avons à peine effleuré la surface de ses capacités. La documentation en ligne Postman est une ressource précieuse pour une exploration plus approfondie.

La collection créée dans ce didacticiel est disponible à l'adresse over sur GitHub.