Tutoriel de test de l'API REST – Exemples de cas de tests manuels

Qu'est-ce que les tests d'API REST ?

Test de l'API REST est une technique de test d'automatisation Web open source utilisée pour tester les API RESTful pour les applications Web. Le but des tests de l'API de repos est d'enregistrer la réponse de l'API de repos en envoyant diverses requêtes HTTP/S pour vérifier si l'API de repos fonctionne correctement ou non. Les tests de l'API restante sont effectués par les méthodes GET, POST, PUT et DELETE.

Reste signifie Transfert d'État représentatif. Il s'agit d'un style architectural et d'une approche de communication utilisée dans le développement de Services Web. REST est devenu un choix logique pour créer des API. Il permet aux utilisateurs de se connecter et d'interagir efficacement avec les services cloud.

Une API ou interface de programmation d'application est un ensemble d'instructions de programmation permettant d'accéder à une application logicielle basée sur le Web. En d’autres termes, un ensemble de commandes utilisées par un programme individuel pour communiquer directement entre elles et utiliser les fonctions de chacun pour obtenir des informations. Par exemple, un site Web Google peut disposer d'une API pour diverses fonctions telles que la recherche, les traductions, les calendriers, etc.

En général, les API sont comme ci-dessous, elles ont le nom du serveur, les chemins..., etc.

http://<server name>/v1/export/Publisher/Standard_Publisher_Report?format=csv

Types de méthodes API

Il existe principalement 4 types de Test d'API méthodes : GET, POST, Supprimer et PUT.

  • ÉCONOMISEZ– La méthode GET est utilisée pour extraire des informations du serveur donné en utilisant un URI donné. Lors de l'utilisation de la requête GET, elle ne doit extraire que des données et ne doit avoir aucun autre effet sur les données.
  • POSTEZ– Une requête POST est utilisée pour créer une nouvelle entité. Il peut également être utilisé pour envoyer des données au serveur, par exemple des informations client, le téléchargement de fichiers, etc. à l'aide de formulaires HTML.
  • PUT– Créez une nouvelle entité ou mettez à jour une entité existante.
  • EFFACER– Supprime toutes les représentations actuelles de la ressource cible données par un URI.

Comment tester l'API REST

Les tests d'API nécessitent qu'une application interagisse avec un exemple d'API à des fins de test. Pour tester une API, vous avez besoin de deux choses,

  • Outil/Framework de test pour piloter l'API
  • Écrire votre propre code pour tester l'exemple d'API REST

Les cas de test de l'API Rest peuvent être testés avec des outils tels que :

  • Client de repos avancé
  • Postman-Repos Client
  • Curl sous Linux

Ici, nous utiliserons Advanced Rest Client, vous trouverez ci-dessous les étapes pour obtenir Advance Rest Client,

Comment obtenir le client Advanced Rest ?

    • Allez dans Google ChromeLa boutique en ligne de
    • Recherchez « Advanced Rest Client » ou accédez directement here. et installez l'extension

Comment installer le client Advance Rest

  • Sélectionnez l'icône « Advanced Rest Client » dans la section des applications de Chrome – chrome://apps/

Une fois l'installation terminée, suivez le test ci-dessous pour tester API RESTful

Étapes pour tester l'API REST

Ici, nous utilisons l'extension client rest dans le navigateur Chrome. Pour comprendre clairement, nous utilisons une API factice pour les tests »

http://ip.jsontest.com/

Étape 1) Ouvrez le client REST avancé

Lancez l'application Advanced REST Client (ARC), une fois qu'elle est installée avec succès.

Ouvrir le client REST avancé

Étape 2) Entrez l'URL de l'API à tester

Entrez l’exemple d’URL de l’API REST à tester dans la zone de texte URL.

URL de l'API à tester

Étape 3) Sélectionnez la méthode HTTP

Sélectionnez la méthode pour le type de méthodes HTTP dans les tests API à cliquer, par exemple POST

Méthode HTTP

Étape 4) Fournir un ensemble d'en-têtes

Fournissez un ensemble d'en-têtes, dans la zone de texte En-têtes. Cliquez sur Insérer un ensemble d'en-têtes.

Ensemble d'en-têtes

Étape 5) Confirmez le jeu d'en-têtes

Cliquez ensuite sur UTILISER CET ENSEMBLE.

Ensemble d'en-têtes

Étape 6) Fournir le contenu du corps requis

  1. Passez maintenant à l'onglet Corps.
  2. Définissez le type de contenu du corps requis et la vue Éditeur, par exemple Type de contenu du corps : application/json
  3. Vue éditeur : saisie brute.
  4. Sous Payload, transmettez le corps de la requête de l'API de démonstration pour le tester sous la forme de paires clé-valeur, par exemple {{"key1″:"value1″,"key2″:"value2"}. S'il s'agit d'une post-API, nous devons alors transmettre le corps ou les paramètres. Nous passerons sous une charge utile donnée.
{"property" : ["Sites"], "report_type" : ["ALL"]}

Étapes pour tester l'API REST

Étape 7) Soumettez les détails pour démarrer le test

  1. Appuyez sur le bouton d'envoi.
  2. Vous pouvez cliquer sur le bouton DÉTAILS pour voir les en-têtes de réponse.

Étapes pour tester l'API REST

Voici les détails de la réponse :

Étapes pour tester l'API REST

Valider les résultats

Principalement, pour les tests d'API Web, nous devons vérifier le code de réponse, un message de réponse et le corps de la réponse.

Vous trouverez ci-dessous les différents codes de réponse que l'on peut rencontrer lors des tests d'API.

Validation des résultats

Outil de test de l'API REST

Défis pour les tests d'API

Les problèmes intéressants pour les testeurs lors des tests des services REST sont :

  1. S'assurer que le harnais de test fait varier les paramètres des appels d'API de manière à vérifier la fonctionnalité et à exposer les échecs. Cela comprend l'exploration des conditions aux limites et l'attribution de paramètres communs
  2. Création de combinaisons intéressantes de valeurs de paramètres pour les appels avec deux paramètres ou plus
  3. Identifier le contenu sous lequel les appels API doivent être effectués. Cela peut inclure la définition de conditions d'environnement externes (périphériques, fichiers, etc.) ainsi que des données stockées en interne qui affectent l'API.
  4. Séquençage des appels d'API selon l'ordre dans lequel la fonction sera exécutée
  5. Faire en sorte que l'API produise des résultats utiles à partir d'appels successifs.

Résumé

  • Une API ou interface de programmation d'application est un ensemble d'instructions de programmation permettant d'accéder à une application logicielle basée sur le Web.
  • Il existe principalement 4 méthodes impliquées dans les tests d'automatisation de l'API REST, telles que GET, POST, Delete et PUT.
  • Nous devons vérifier le code de réponse, le message de réponse et le corps de la réponse dans les cas de test API Testing.