Chaînage de requêtes et de réponses d’API à l’aide de Postman

API

API signifie Application Programming Interface qui fonctionne comme un intermédiaire entre deux applications pour servir la demande et les réponses.

Les API sont développées pour accélérer la fonctionnalité et le mécanisme de réponse aux demandes d’une application. Elles permettent d’ajouter des fonctionnalités d’autres fournisseurs au système existant, il peut s’agir de différentes sources d’informations, de services de vérification ou de services de communication.

Fondamentalement, l’API est essentiellement un composant qui permet la communication entre deux applications différentes, ces applications peuvent être développées différemment comme le système d’exploitation utilisé peut être différent, Tech Stack peut être différent, la base de données utilisée peut être différente.

L’API permet aux développeurs de faire un appel/demande afin d’envoyer et de recevoir des informations d’un serveur. L’API utilise JavaScript Object Notation pour communiquer via HTTP, c’est-à-dire le protocole de transfert hypertexte. Les requêtes HTTP sont envoyées par les machines clientes pour obtenir ou recevoir des informations du serveur. Il comporte quatre éléments principaux, à savoir – Une méthode HTTP, des types de requête tels que GET, PUT, POST, etc., Request HEAD/OPTIONS et Request Body.

Ce sont les types de base de requête HTTP-

1. OBTENIR

2. POSTE

3. METTRE

4. SUPPRIMER

Dans ce blog, nous allons apprendre le chaînage requête/réponse à l’aide de l’un des outils de test d’API les plus populaires, c’est-à-dire POSTMAN-

Énoncé du problème-

Lors du test d’une API, nous avons l’habitude de faire face à un problème où nous devons fournir la réponse d’une API en tant que paramètre de demande pour une autre API.

Plus précisément, nous allons apprendre à obtenir une réponse d’une API et à la passer en paramètre de requête dans une autre API.

Dans l’exemple actuel, j’utilise 2 API pour enchaîner leur demande et leurs réponses

La première API permet de télécharger un fichier et sur cette base, elle génère un identifiant unique de bon de travail.

La deuxième API utilise l’identifiant du bon de travail pour vérifier l’état du document téléchargé.

Nous aurions besoin de suivre les étapes suivantes pour atteindre le même-

Étape 1:

Allez dans Postman et cliquez sur Nouveau -> Collection -> Ajouter un nom à votre collection, dites API_Chaining

Étape 2:

Créez/Ajoutez la première requête API que vous souhaitez enchaîner et enregistrez-la, elle donnera la réponse au format suivant –

{

« MSG »: « Bon de travail créé »,

« WORKORDER_ID »: « 12345678909876« 

}

Étape 3:

Utilisez la variable d’environnement pour paramétrer la valeur de réponse de l’API 1.

Pour ce faire, allez dans Nouveau -> Environnement et fournissez un nom d’environnement

Ajoutez un nouveau nom de variable, dites « Dynamic_WorkOrderID » et fournissez une valeur initiale telle que abc.

Sélectionnez l’environnement nouvellement créé dans le coin supérieur droit.

Étape 4:

Ajoutez maintenant le script de test pour définir la valeur de WorkOrder ID dans la variable ‘Dynamic_WorkOrderID’

Accédez à l’onglet Test et ajoutez le script pour définir dynamiquement la valeur de l’ID de l’ordre de travail.

valeurcorps = JSON.analyser(responseBody)

bodyData = valeurcorps.DEMANDE DE SERVICE_IDENTIFIANT

console.Journal(bodyData)

pm.environnement.Positionner(« Dynamique_OtravailOcommanderIDENTIFIANT« , bodyData);

La première ligne valeurcorps = JSON.analyser(responseBody)récupèrera la valeur du corps de la réponse de l’API 1

Maintenant, nous aurions besoin de fournir le chemin JSON de la variable dont nous voulons définir dynamiquement la valeur dans la variable d’environnement-

Ainsi, la deuxième ligne définit la valeur de WORKORDER_ID dans la variable bodyData

bodyData = valeurcorps.DEMANDE DE SERVICE_IDENTIFIANT

Cette instruction imprime simplement la valeur qui est définie sous la variable bodyData

console.Journal(bodyData)

Maintenant, nous aurions besoin de définir la valeur de la variable bodyData dans la variable d’environnement, c’est-à-dire Dynamic_WorkOrderID.

pm.environnement.Positionner(« Dynamique_OtravailOcommanderIDENTIFIANT« , bodyData);

Étape 5 :

Allez maintenant à l’API 2 et définissez le paramètre body comme ci-dessous –

{

« workorder_id »: « {{Dynamique_WorkOrderID}}« 

}

Cela définira la valeur du paramètre de corps ‘workorder_id’ selon la valeur de la valeur de la variable d’environnement et l’utilisateur n’a pas besoin de le définir manuellement, encore et encore, pour vérifier l’état des différents ID de bon de travail et l’utilisateur peut simplement appuyer sur l’envoi bouton de demande afin d’obtenir la réponse de cette API.

TROUVÉ CELA UTILE ? PARTAGEZ-LE