Comment utiliser les scripts de requête post dans Postman ?

Vous connaissez probablement Postman. Si vous êtes un développeur ou un testeur d'API, vous connaissez probablement déjà Postman. C'est un outil populaire pour les tests d'API, et il regorge de fonctionnalités qui facilitent la simulation des requêtes et l'analyse des réponses. Mais saviez-vous que vous pouvez également utiliser Postman pour automatiser les tâches et ajouter un comportement dynamique à vos requêtes ? C'est là que les scripts post-requête entrent en jeu.

Que sont les scripts post-requête ?

Les scripts post-requête, également appelés scripts de test, sont des morceaux de code JavaScript que Postman exécute après avoir envoyé une requête. Ces scripts s'exécutent après l'envoi de la requête réelle et la réception de la réponse. Ils sont utilisés pour vérifier si l'API fonctionne correctement, valider les intégrations et s'assurer que les nouveaux développements n'ont pas affecté les fonctionnalités existantes.

Alors que les scripts pré-requête configurent la requête, les scripts post-requête analysent la réponse. Par exemple, vous pouvez vérifier que les données attendues sont présentes dans la réponse ou effectuer des vérifications supplémentaires.

Qu'est-ce que  postman

Postman est une plateforme de développement et de test d'API qui offre une variété de fonctionnalités. Il permet aux développeurs de créer et de partager facilement des requêtes et des collections d'API, d'automatiser les tests, de simuler des API et de surveiller les performances. Postman fournit également des outils de collaboration et de documentation, permettant aux équipes de travailler ensemble plus efficacement et de communiquer le comportement des API de manière efficace

Quand utiliser les scripts post-requête ?

Les scripts post-requête sont incroyablement polyvalents et vous pouvez les utiliser dans de nombreux scénarios différents. Les scripts post-requête s'exécutent après la réception de la réponse. Ils sont utilisés pour vérifier si l'API fonctionne correctement, vérifier les intégrations et s'assurer que les nouveaux changements n'ont pas affecté les fonctionnalités existantes. Vous pouvez écrire des scripts de test en JavaScript pour valider la réponse.

Comment utiliser les scripts post-requête ?

1. Ouvrez Postman et accédez à l'onglet « Tests » qui se trouve à côté des onglets « Headers » et « Body » dans la fenêtre de requête.

Écrivez vos tests JavaScript dans cet onglet. Postman fournit un riche ensemble d'extraits sur le côté droit pour vous aider à démarrer. Par exemple, la longueur des éléments de données doit être supérieure à zéro :

Écrivez vos tests JavaScript dans cet onglet. Postman fournit un riche ensemble d'extraits sur le côté droit pour vous aider à démarrer. Par exemple, pour vérifier si le corps de la réponse contient une certaine chaîne, vous pouvez utiliser :

// Verify the length of data elements
pm.test("The length of data elements should be greater than zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "ID should not be empty");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "Name should not be empty");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls should not be empty");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "Category ID should not be empty");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "Category name should not be empty");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "Tag ID should not be empty");
        pm.expect(tag.name.length).to.be.greaterThan(0, "Tag name should not be empty");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "Status should not be empty");
});

Dans l'onglet « Résultats des tests » en bas de la section de réponse. Si votre script a réussi, il apparaîtra en vert ; s'il a échoué, il sera en rouge.

Utiliser Post-Request dans les scripts Apidog.

Apidog est un ensemble complet d'outils qui connecte l'ensemble du cycle de vie de l'API. Il combine des fonctionnalités d'outils tels que Postman, Swagger, Mock et JMeter. Apidog aide les équipes R&D à mettre en œuvre les meilleures pratiques pour le développement API Design-first. Son interface conviviale facilite la conception, le débogage, la documentation, la simulation et le test des API.

L'utilisation de scripts post-requête dans Apidog est un excellent moyen d'automatiser les tests de vos réponses d'API. Voici un guide étape par étape sur la façon de les utiliser :

Configurez votre requête :

• Dans Apidog, créez une nouvelle requête en cliquant sur le bouton « + » ou en sélectionnant « Nouvelle API ».
• Entrez l'URL de la ressource que vous souhaitez mettre à jour (le point de terminaison où vous enverrez votre requête POST).
• Ajoutez tous les en-têtes ou paramètres supplémentaires dont vous avez besoin pour votre requête.

Écrivez des scripts post-requête :

• Accédez à l'onglet « Post processors » à côté des onglets « Headers » et « Body » dans la fenêtre de requête.

// Verify the length of data elements
pm.test("The length of data elements should be greater than zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "ID should not be empty");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "Name should not be empty");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls should not be empty");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "Category ID should not be empty");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "Category name should not be empty");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "Tag ID should not be empty");
        pm.expect(tag.name.length).to.be.greaterThan(0, "Tag name should not be empty");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "Status should not be empty");
});

Apidog vous permet d'ajouter différents types de scripts post-requête

Envoyez la requête POST :

• Cliquez sur le bouton « Envoyer » pour exécuter votre requête POST.

Affichez les résultats des tests dans l'onglet à droite de la section de réponse. Si votre script a réussi, il apparaîtra en vert ; s'il a échoué, il sera en rouge.

Les scripts post-requête sont particulièrement utiles pour :

• Valider la réponse : assurez-vous que l'API renvoie le code d'état, le temps de réponse et la structure de données attendus.
• Définir des variables d'environnement : extrayez les données de la réponse et définissez-les comme variable d'environnement à utiliser dans les requêtes suivantes.
• Tests basés sur les données : comparez la réponse à un ensemble de données pour la validation.

Conclusion

Les scripts post-requête sont une fonctionnalité puissante de Postman qui peut vous aider à automatiser les tâches, à ajouter un comportement dynamique à vos requêtes et à vous assurer que vos API fonctionnent comme prévu. Alors, pourquoi ne pas les essayer ? Vous pourriez être surpris de voir à quel point ils peuvent simplifier votre processus de test d'API.