Tutoriel EchoAPI : Comment utiliser les scripts dans EchoAPI

Dans ce didacticiel, nous explorerons comment utiliser des scripts dans EchoAPI pour les tests et le développement avancés d'API. Les scripts EchoAPI, écrits en JavaScript, vous permettent d'ajouter des fonctionnalités dynamiques à vos requêtes API. En comprenant les scripts de pré-exécution et de post-exécution, vous pouvez améliorer vos capacités de test, gérer les variables et manipuler les paramètres de requête sans effort. Plongeons dans les puissantes fonctionnalités des scripts EchoAPI et voyons comment ils peuvent rationaliser votre flux de travail API.

Qu'est-ce que le script EchoAPI ?

Les scripts EchoAPI sont des extraits de code basés sur JavaScript qui permettent d'ajouter un comportement dynamique lors de requêtes API ou de tests de collecte.

Fonctions des scripts EchoAPI

Les scripts peuvent réaliser les fonctions suivantes :

• Tester (affirmer) l'exactitude des résultats de réponse à la demande (scripts post-exécution).
• Modifiez dynamiquement les paramètres de demande d'API, tels que l'ajout de paramètres de signature d'API (scripts de pré-exécution).
• Transmettre des données entre les requêtes API (à l'aide de variables dans les scripts).
• Faites des requêtes directement à un point de terminaison d'API dans le script.

Les scripts EchoAPI sont divisés en scripts de pré-exécution et de post-exécution.

Scripts de pré-exécution

Les scripts de pré-exécution sont exécutés avant l'envoi d'une requête.

Scripts de post-exécution

Les scripts de post-exécution sont exécutés après l'envoi d'une requête.

Exemple de soumission réelle

Comme le montre le diagramme ci-dessous (sortie de la console), le script de pré-exécution s'exécute avant l'envoi de la requête et le script de post-exécution s'exécute une fois la requête terminée :

Fonctions des scripts de pré-exécution

Les scripts de pré-exécution ont plusieurs fonctions clés :

• Effectuez des calculs complexes à l'aide des fonctions JS.
• Imprimer les valeurs des variables.
• Définissez, récupérez, supprimez et effacez les variables d'environnement.
• Définissez, récupérez, supprimez et effacez les variables globales.
• Paramètres de la demande d'accès.
• Ajoutez ou supprimez dynamiquement des paramètres d'en-tête.
• Ajoutez ou supprimez dynamiquement des paramètres de requête.
• Ajoutez ou supprimez dynamiquement des paramètres corporels.
• Envoyer des requêtes HTTP.

Par exemple, on peut définir une fonction _random dans le script de pré-exécution :

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Cette fonction renvoie une chaîne : "Bonjour, EchoAPI" suivie d'un nombre aléatoire. On peut alors l'attribuer à une variable globale random_var comme suit :

pm.globals.set("random_var", _random());

Impression des variables de débogage dans les scripts de pré-exécution

Nous pouvons utiliser console.log() pour imprimer les variables nécessaires sur la console et afficher les valeurs actuelles de ces variables.

Gestion des variables d'environnement

• Définition d'une variable d'environnement :

  pm.variables.set("key", "value"); // Set an environment variable 'key' with value 'value'

• Récupération d'une variable d'environnement :

  pm.variables.get("key"); // Get the value of the environment variable 'key'

• Suppression d'une variable d'environnement :

  pm.variables.delete("key"); // Delete the environment variable 'key'

• Effacer toutes les variables d'environnement :

  pm.variables.clear(); // Clear all defined environment variables

Gestion des variables globales

• Définition d'une variable globale :

  pm.globals.set("key", "value"); // Set a global variable 'key' with value 'value'

• Récupération d'une variable globale :

  pm.globals.get("key"); // Get the value of the global variable 'key'

• Supprimer une variable globale :

  pm.globals.delete("key"); // Delete the global variable 'key'

• Effacer toutes les variables globales :

  pm.globals.clear(); // Clear all defined global variables

Accès aux paramètres de requête

Les paramètres de la requête sont accessibles via l'objet de requête. Pour plus de détails, reportez-vous à la section « Variables intégrées EchoAPI ».

Gestion dynamique des paramètres de requête

• Ajout d'un paramètre d'en-tête :

  pm.setRequestHeader("key", "value"); // Dynamically add a header parameter with key 'key' and value 'value'

• Suppression d'un paramètre d'en-tête :

  pm.removeRequestHeader("key"); // Remove the header parameter with key 'key'

• Ajout d'un paramètre de requête :

  pm.setRequestQuery("key", "value"); // Dynamically add a query parameter

• Suppression d'un paramètre de requête :

  pm.removeRequestQuery("key"); // Remove the query parameter with key 'key'

• Ajout d'un paramètre body :

  pm.setRequestBody("key", "value"); // Dynamically add a body parameter

• Supprimer un paramètre de corps :

  pm.removeRequestBody("key"); // Remove the body parameter with key 'key'

Envoi de requêtes HTTP dans des scripts de pré-exécution

Vous pouvez envoyer une requête HTTP en utilisant la méthode $.ajax() d'AJAX dans un script de pré-exécution. Voici un exemple simple où une requête est envoyée à https://echo.apipost.cn/get.php et le bigint de la réponse est attribué à une variable globale bigint :

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Fonctions des scripts de post-exécution

Les scripts de post-exécution sont exécutés après l'envoi d'une requête et peuvent exécuter bon nombre des mêmes fonctions que les scripts de pré-exécution, notamment :

• Effectuez des calculs complexes à l'aide des fonctions JS.
• Imprimer les valeurs des variables.
• Définissez, récupérez, supprimez et effacez les variables d'environnement.
• Définissez, récupérez, supprimez et effacez les variables globales.
• Accéder aux paramètres de demande et de réponse.
• Envoyer des requêtes HTTP.
• Tester (affirmer) l'exactitude des résultats de la réponse à la demande.

Les méthodes de définition, de récupération, de suppression et d'effacement des variables d'environnement et globales sont les mêmes que celles des scripts de pré-exécution et ne seront pas répétées ici.

Réception des paramètres de réponse

Vous pouvez accéder aux paramètres de réponse via l'objet de réponse. Pour des opérations détaillées, reportez-vous à la section « Variables intégrées EchoAPI ».

Test de la validité de la réponse à la demande

Vous pouvez utiliser des scripts de post-exécution pour tester (affirmer) l'exactitude des résultats de la réponse à la demande.

Conclusion

En résumé, les scripts EchoAPI offrent un moyen robuste d'améliorer vos processus de test et de développement d'API. En tirant parti des scripts de pré-exécution et de post-exécution, vous pouvez gérer dynamiquement les paramètres de requête, affirmer la validité des réponses et utiliser efficacement les variables. Cette fonctionnalité rationalise non seulement le processus de test, mais permet également des opérations plus complexes, facilitant ainsi la garantie de l'exactitude et de l'efficacité de vos intégrations d'API. Commencez à implémenter les scripts EchoAPI dès aujourd'hui et améliorez votre expérience de test d'API !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!