Tutoriel de test d'API: un guide complet pour les débutants

api testing tutorial

Ce didacticiel détaillé sur les tests d'API explique tout sur les tests d'API, les services Web et comment introduire les tests d'API dans votre organisation:

Obtenez un aperçu approfondi des tests d'API ainsi que du concept de test de décalage à gauche et des services Web à partir de ce didacticiel d'introduction.

meilleur programme pour convertir youtube en mp3

Des concepts tels que l'API Web, le fonctionnement de l'API (avec un exemple réel) et en quoi est-il différent des services Web sont bien expliqués avec des exemples dans ce didacticiel.

=>DÉFILER VERS LE BASpour voir la liste complète de 5 didacticiels de test d'API approfondis pour les débutants

Ce que vous apprendrez:

• Liste des didacticiels de test d'API
• Présentation des didacticiels de cette série de tests d'API
• Tutoriel de test d'API
  • Test de décalage vers la gauche
  • Cycle de vie du développement logiciel (SDLC) avant les tests de passage à gauche
  • Phases du test de décalage gauche
  • API Web
  • Comment fonctionne une API?
  • Services Web
  • Services Web vs API Web
• Présentation des tests d'API dans votre organisation
  • Priorité aux tests d'API
  • Spectre complet de tests d'API
    • (i) Test fonctionnel
    • (ii) Test de charge et de performance
    • (iii) Test de sécurité
  • Comment introduire les tests d'API dans votre organisation
  • Défis courants et moyens de les atténuer
    • # 1) Choisir le bon outil
    • # 2) Spécifications de test manquantes
    • # 3) Courbe d'apprentissage
    • # 4) Ensemble de compétences existant
  • Étude de cas
• Conclusion
  • lecture recommandée

Liste des didacticiels de test d'API

Tutoriel n ° 1: Tutoriel de test d'API: un guide complet pour les débutants
Tutoriel n ° 2: Tutoriel sur les services Web: composants, architecture, types et exemples
Tutoriel n ° 3: Top 35 des questions d'entrevue avec ASP.Net et API Web avec réponses
Tutoriel n ° 4: Tutoriel POSTMAN: Test d'API avec POSTMAN
Tutoriel n ° 5: Test des services Web à l'aide du client HTTP Apache

Présentation des didacticiels de cette série de tests d'API

Tutoriel de test d'API

Cette section vous aidera à acquérir une compréhension de base des services Web et de l'API Web, ce qui, à son tour, vous aidera à comprendre les principaux concepts des didacticiels à venir de cette série de tests d'API.

L'API (Application Programming Interface) est un ensemble de toutes les procédures et fonctions qui nous permettent de créer une application en accédant aux données ou fonctionnalités du système d'exploitation ou des plateformes. Le test de ces procédures est connu sous le nom de test API.

Test de décalage vers la gauche

L'un des types de tests importants qui est demandé de nos jours dans les entretiens de test API est le test Shift Left. Ce type de test est pratiqué dans presque tous les projets qui suivent une méthodologie Agile.

Avant l'introduction de Shift Left Testing, les tests logiciels ne sont apparus qu'une fois le codage terminé et le code livré aux testeurs. Cette pratique a conduit à une hâte de dernière minute pour respecter le délai et a également entravé dans une large mesure la qualité du produit.

En dehors de cela, les efforts consentis (lorsque des défauts ont été signalés lors de la dernière phase avant la production) ont été énormes car les développeurs ont dû repasser à nouveau par la phase de conception et de codage.

Cycle de vie du développement logiciel (SDLC) avant les tests de passage à gauche

Le flux SDLC traditionnel était: Exigence -> Conception -> Codage -> Test.

Inconvénients des tests traditionnels

• Les tests sont à l'extrême droite. Beaucoup de frais sont engagés lorsqu'un bug est identifié à la dernière minute.
• Le temps passé à résoudre le bogue et à le tester à nouveau avant de le promouvoir en production est énorme.

Par conséquent, une nouvelle idée est apparue pour déplacer la phase de test vers la gauche, ce qui a conduit à Shift Left Testing.

Lecture suggérée => Shift Left Testing: un mantra secret pour la réussite des logiciels

Phases du test de décalage gauche

Les tests de décalage à gauche ont conduit à une migration réussie de la détection des défauts vers la prévention des défauts. Cela a également aidé le logiciel à échouer rapidement et à résoudre toutes les pannes au plus tôt.

API Web

En termes généraux, une API Web peut être définie comme quelque chose qui prend la demande d'un système client à un serveur Web et renvoie la réponse d'un serveur Web à une machine cliente.

Comment fonctionne une API?

Prenons un scénario très courant de réservation d'un vol sur www.makemytrip.com, un service de voyage en ligne qui regroupe les informations de plusieurs compagnies aériennes. Lorsque vous effectuez une réservation de vol, vous entrez des informations telles que la date du voyage / la date de retour, la classe, etc. et cliquez sur Rechercher.

Cela vous montrera le prix de plusieurs compagnies aériennes et leur disponibilité. Dans ce cas, l'application interagit avec les API de plusieurs compagnies aériennes et donne ainsi accès aux données de la compagnie aérienne.

Un autre exemple est www.trivago.com qui compare et répertorie les prix, la disponibilité, etc. de différents hôtels d'une ville particulière. Ce site Web communique avec les API de plusieurs hôtels pour accéder à la base de données et répertorie les prix et la disponibilité de leur site Web.

Ainsi, une API Web peut être définie comme «une interface qui facilite la communication entre une machine cliente et le serveur Web».

Services Web

Les services Web sont (comme l'API Web) les services qui servent d'une machine à une autre. Mais la principale différence entre l'API et les services Web est que les services Web utilisent un réseau.

Il est sûr de dire que tous les services Web sont des API Web mais que toutes les API Web ne sont pas des services Web (expliqué dans la dernière partie de l'article). Ainsi, les services Web sont un sous-ensemble de l'API Web. Reportez-vous au diagramme ci-dessous pour en savoir plus sur l'API Web et les services Web.

API Web vs services Web

Services Web vs API Web

L'API Web et les services Web sont utilisés pour faciliter la communication entre le client et le serveur. La différence majeure réside uniquement dans la manière dont ils communiquent.

Chacun d'eux nécessite un corps de requête acceptable dans une langue spécifique, leurs différences dans la fourniture d'une connexion sécurisée, leur vitesse de communication avec le serveur et de réponse au client, etc.

Les différences entre les services Web et l'API Web sont répertoriées ci-dessous à titre de référence.

Service Web

• Les services Web utilisent généralement XML (Extensible Markup Language), ce qui signifie qu'ils sont plus sécurisés.
• Les services Web sont plus sécurisés car les services Web et les API fournissent SSL (Secure Socket Layer) pendant la transmission des données, mais ils fournissent également WSS (Web Services Security).
• Le service Web est un sous-ensemble de l'API Web. Par exemple, Les services Web sont basés uniquement sur trois styles d'utilisation, à savoir SOAP, REST et XML-RPC.
• Les services Web ont toujours besoin d'un réseau pour fonctionner.
• Les services Web prennent en charge «différentes applications à code unique». Cela signifie qu'un code plus générique est écrit dans différentes applications.

API Web

• Une API Web utilise généralement JSON (JavaScript Object Notation), ce qui signifie que l'API Web est plus rapide.
• L'API Web est plus rapide car JSON est léger, contrairement à XML.
• Les API Web sont le sur-ensemble des services Web. Par exemple, Les trois styles de services Web sont également présents dans l'API Web, mais à part cela, il utilise d'autres styles tels que JSON - RPC.
• L'API Web ne nécessite pas nécessairement un réseau pour fonctionner.
• L'API Web peut prendre en charge ou non l'interopérabilité en fonction de la nature du système ou de l'application.

Présentation des tests d'API dans votre organisation

Dans notre vie quotidienne, nous sommes tous tellement habitués à interagir avec les applications avec des API et pourtant nous ne pensons même pas aux processus back-end qui gèrent la fonctionnalité sous-jacente.

Par exemple, Considérons que vous parcourez les produits sur Amazon.com et que vous voyez un produit / une offre que vous aimez vraiment et que vous souhaitez le partager avec votre réseau Facebook.

Au moment où vous cliquez sur l'icône Facebook dans la section de partage de la page et entrez les informations d'identification de votre compte Facebook à partager, vous interagissez avec une API qui connecte de manière transparente le site Web d'Amazon à Facebook.

Priorité aux tests d'API

Avant de discuter plus en détail des tests d'API, examinons les raisons pour lesquelles les applications basées sur l'API ont gagné en popularité ces derniers temps.

Il existe plusieurs raisons pour lesquelles les organisations font la transition vers des produits et des applications basés sur des API. Et peu d'entre eux sont inscrits ci-dessous pour votre référence.

#1) Les applications basées sur l'API sont plus évolutives que les applications / logiciels traditionnels. Le taux de développement de code est plus rapide et la même API peut traiter plus de demandes sans aucun changement majeur de code ou d'infrastructure.

#deux) Les équipes de développement n'ont pas besoin de commencer à coder à partir de zéro chaque fois qu'elles commencent à travailler sur le développement d'une fonctionnalité ou d'une application. Les API réutilisent le plus souvent des fonctions existantes et répétables, des bibliothèques, des procédures stockées, etc. et, par conséquent, ce processus peut les rendre globalement plus productives.

Par exemple, Si vous êtes un développeur travaillant sur un site Web de commerce électronique et que vous souhaitez ajouter Amazon en tant que processeur de paiement, vous n'avez pas à écrire le code à partir de zéro.

Tout ce que vous avez à faire est de configurer l'intégration entre votre site Web et l'API Amazon à l'aide des clés d'intégration et d'appeler l'API Amazon pour traiter les paiements lors du paiement.

# 3) Les API permettent une intégration facile avec les autres systèmes à la fois pour les applications autonomes prises en charge ainsi qu'avec les produits logiciels basés sur les API.

Par exemple , Supposons que vous souhaitiez envoyer un envoi de Toronto à New York. Vous allez en ligne, accédez à un site Web de fret ou de logistique bien connu et entrez les informations requises.

Après avoir fourni les informations obligatoires, lorsque vous cliquez sur le bouton Obtenir les tarifs - dans le back-end, ce site Web de logistique peut se connecter à plusieurs API et applications de transporteur et de fournisseur de services pour obtenir les tarifs dynamiques pour la combinaison de lieux d'origine à destination.

Spectre complet de tests d'API

Le test des API ne se limite pas à l'envoi d'une requête à l'API et à l'analyse de la réponse pour la seule exactitude. Les API doivent être testées pour leurs performances sous différentes charges de vulnérabilités.

Discutons-en en détail.

lister tous les systèmes d'exploitation que vous connaissez

(i) Test fonctionnel

Les tests fonctionnels peuvent être une tâche difficile en raison de l'absence d'interface graphique.

Voyons comment le approche de test fonctionnel pour les API est différent de l'application basée sur l'interface graphique et nous discuterons également de quelques exemples autour de celle-ci.

à) La différence la plus évidente est qu'il n'y a aucune interface graphique avec laquelle interagir. Les testeurs qui effectuent généralement des tests fonctionnels basés sur l'interface graphique trouvent un peu plus difficile de passer aux tests d'applications non-GUI par rapport à quelqu'un qui le connaît déjà.

Au départ, avant même de commencer à tester l'API, vous devrez tester et vérifier le processus d'authentification lui-même. La méthode d'authentification variera d'une API à une autre API et impliquerait une sorte de clé ou de jeton pour l'authentification.

Si vous ne parvenez pas à vous connecter à l'API avec succès, les tests supplémentaires ne peuvent pas se poursuivre. Ce processus peut être considéré comme comparable à l'authentification utilisateur dans les applications standard où vous avez besoin d'informations d'identification valides pour vous connecter et utiliser l'application.

b) Tester les validations de champ ou la validation des données d'entrée est très important lors du test des API. Si une interface réelle basée sur un formulaire (GUI) était disponible, les validations de champ pourraient être implémentées dans le frontal ou le backend, garantissant ainsi qu'un utilisateur n'est pas autorisé à entrer des valeurs de champ non valides.

Par exemple, Si une application a besoin que le format de date soit JJ / MM / AAAA, nous pouvons appliquer cette validation sur le formulaire de collecte des informations pour nous assurer que l'application reçoit et traite une date valide.

Ce n'est cependant pas la même chose pour les applications API. Nous devons nous assurer que l'API est bien écrite et qu'elle est capable d'appliquer toutes ces validations, de faire la distinction entre les données valides et non valides et de renvoyer le code d'état et le message d'erreur de validation à l'utilisateur final via une réponse.

c) Tester l'exactitude des réponses de l'API pour une réponse valide et invalide est en effet crucial. Si un code d'état de 200 (signifiant que tout va bien) est reçu en tant que réponse de l'API de test, mais si le texte de la réponse indique qu'une erreur a été rencontrée, il s'agit d'un défaut.

De plus, si le message d'erreur lui-même est incorrect, cela peut être très trompeur pour le client final qui tente de s'intégrer à cette API.

Dans la capture d'écran ci-dessous, l'utilisateur a entré un poids invalide, qui est supérieur aux 2267 kg acceptables. L'API répond avec le code d'état d'erreur et le message d'erreur. Cependant, le message d'erreur mentionne à tort les unités de poids en livres au lieu de KG. C'est un défaut qui peut dérouter le client final.

(ii) Test de charge et de performance

Les API sont conçues pour être évolutives par conception.

Ceci, à son tour, rend Load et Test de performance essentiel, surtout si le système en cours de conception doit répondre à des milliers de demandes par minute ou heure, selon les besoins. Effectuer régulièrement des tests de charge et de performance sur l'API peut aider à évaluer les performances, les pics de charge et le point de rupture.

Ces données sont utiles lors de la planification de la mise à l'échelle d'une application. La disponibilité de ces informations aidera à prendre en charge les décisions et la planification, en particulier si l'organisation prévoit d'ajouter plus de clients, ce qui signifierait plus de demandes entrantes.

Par exemple , disons qu'en fonction des exigences fournies, nous savons que l'API qui est conçue doit traiter au moins 500 requêtes par heure et maintenir un temps de réponse moyen inférieur à 0,01 seconde.

Sur la base de nos tests de charge et de performances, nous avons découvert que tant que l'API reçoit moins de 500 requêtes par heure, elle est capable de maintenir un SLA pour un temps de réponse moyen. Cependant, s'il reçoit 200 demandes supplémentaires, le temps de réponse moyen augmente et le point de rupture est atteint lorsque la demande entrante dépasse 1 200 par heure.

Habituellement, on constate que lors des phases de conception initiales, l'accent est souvent mis sur les aspects fonctionnels de l'API. Au fil du temps, un produit commence à prendre en charge plusieurs clients en direct, c'est à ce moment que les tests des performances de l'API et des tests de charge entrent en jeu de manière plus routinière.

(iii) Test de sécurité

Les interfaces ou API de programmation d'application sont vulnérables et constituent le point d'accès le plus simple pour les pirates malveillants qui souhaitent accéder aux données ou prendre le contrôle d'une application.

Cela peut conduire toute entreprise à des problèmes juridiques, où, en raison d'une faille de sécurité, des personnes et / ou des organisations involontaires peuvent accéder aux données du client via une API vénérable.

Test de sécurité est une branche spécialisée des tests et doit être confiée à des spécialistes. Les ressources de test de sécurité peuvent provenir de l’organisation ou de consultants indépendants.

Lire aussi = >> Qu'est-ce que le test de contrat Pact

Comment introduire les tests d'API dans votre organisation

Le processus d'introduction des tests d'API dans toute organisation est similaire au processus utilisé pour mettre en œuvre ou déployer tout autre outil et cadre de test.

Le tableau ci-dessous résume les principales étapes ainsi que le résultat attendu de chaque étape.

Défis courants et moyens de les atténuer

Discutons de certains des défis courants auxquels les équipes d'assurance qualité sont confrontées lorsqu'elles tentent de mettre en œuvre un cadre de test d'API dans une organisation.

# 1) Choisir le bon outil

La sélection du bon outil pour le travail est le défi le plus courant. Il existe plusieurs outils de test d'API disponibles sur le marché.

Il peut sembler très intéressant de mettre en œuvre l'outil le plus récent et le plus cher disponible sur le marché, mais s'il n'apporte pas les résultats escomptés, cet outil ne sert à rien.

Par conséquent, choisissez toujours l'outil qui répond aux exigences «indispensables» en fonction de vos besoins organisationnels.

Voici un exemple de matrice d'évaluation d'outil pour les outils API disponibles

# 2) Spécifications de test manquantes

En tant que testeurs, nous devons connaître les résultats attendus pour tester efficacement une application. C'est souvent un défi, car pour connaître les résultats attendus, nous devons avoir des exigences précises et claires - ce qui n'est pas le cas.

Par exemple , tenez compte des exigences ci-dessous:

'L'application ne doit accepter qu'une date d'expédition valide et toutes les exigences non valides doivent être rejetées'

Ces exigences manquent de détails clés et sont très ambiguës - comment définissons-nous une date valide? Et le format? Renvoyons-nous un message de refus à l'utilisateur final, etc.?

Exemple d'exigences claires:

1) L'application ne doit accepter qu'une date d'expédition valide.

La date d'expédition est considérée comme valide si elle est

• Pas dans le passé
• Supérieur ou égal à la date d'aujourd'hui
• Est dans un format acceptable: JJ / MM / AAAA

2)

Code d'état de réponse = 200
Message: OK

3) La date d'expédition qui ne répond pas aux critères ci-dessus doit être considérée comme invalide. Si un client envoie une date d'expédition non valide, il doit répondre avec le (s) message (s) d'erreur suivant (s):

3.1

Code d'état de réponse PAS 200
Erreur: la date d'expédition fournie n'est pas valide; veuillez vous assurer que la date est au format JJ / MM / AAAA

3.2

Code d'état de réponse PAS 200
Erreur: à condition que la date d'expédition soit dans le passé

# 3) Courbe d'apprentissage

Comme mentionné précédemment, l'approche pour les tests d'API est différente par rapport à l'approche suivie lors du test des applications basées sur l'interface graphique.

questions et réponses d'entretien qtp pour les expérimentés

Si vous embauchez des spécialistes en interne ou des consultants pour les tests d'API, la courbe d'apprentissage de l'approche de test API ou de l'outil de test API peut être minime. Toute courbe d'apprentissage, dans ce cas, serait associée à l'acquisition des connaissances sur le produit ou l'application.

Si un membre de l'équipe existant est affecté à l'apprentissage des tests d'API, alors en fonction de l'outil de choix, la courbe d'apprentissage peut être moyenne à élevée, tout en modifiant l'approche de test. La courbe d'apprentissage pour le produit ou l'application elle-même peut être faible à moyenne selon que ce testeur a testé cette application auparavant ou non.

# 4) Ensemble de compétences existant

Cela rejoint directement le point précédent sur la courbe d'apprentissage.

Si un testeur était en train de passer des tests basés sur l'interface graphique, le testeur devrait alors changer l'approche de test et apprendre le nouvel outil ou le nouveau cadre selon les besoins. Par exemple. Si l'API accepte les demandes au format JSON, le testeur devra alors savoir ce qu'est JSON pour commencer à créer les tests.

Étude de cas

Tâche

Afin de faire évoluer une application existante, une entreprise souhaitait proposer un produit en API ainsi qu'une application GUI standard. L'équipe d'assurance qualité a été invitée à fournir un plan de couverture de test pour s'assurer qu'elle est prête à accueillir les tests d'API au-delà des tests standard basés sur l'interface graphique.

Défis

• Aucun des autres produits logiciels n'avait une architecture basée sur l'API, par conséquent, pour permettre les tests autour de cette tâche, l'équipe doit établir le processus de test API à partir de zéro. Cela signifie que les outils devaient être évalués, présélectionnés, finalisés et l'équipe devait être formée pour les tests.
• Aucun budget supplémentaire n'a été alloué pour l'acquisition et la mise en œuvre de l'outil. Cela signifie que l'équipe devait choisir un outil de test d'API gratuit ou open-source et qu'une personne de l'équipe existante devait être formée pour s'acquitter de cette tâche.
• Il n'y avait aucune exigence pour les champs API et la validation des données. Les exigences étaient «devraient fonctionner de la même manière que l'application graphique correspondante».

L'approche suivie par l'équipe pour atténuer les risques et contourner les défis

• L'équipe d'AQ a travaillé avec l'équipe de projet pour identifier les exigences suivantes:
  • Type d'API (REST / SOAP): DU REPOS
  • Tests requis (fonctionnel, charge, sécurité): Test fonctionnel uniquement
  • Tests automatisés requis (Oui / Non): Facultatif pour l'instant
  • Rapports de test (Oui / Non): Obligatoire
• L'équipe d'AQ a évalué les outils sur les Outils de test d'API basé sur les exigences indispensables. Postman API Tool a été finalisé comme un outil de leur choix car il était gratuit et facile à utiliser, minimisant ainsi la courbe d'apprentissage, et avait le potentiel d'automatiser les tests, et était livré avec de bons rapports intégrés.
• Le même testeur qui a testé l'application a été formé à l'utilisation de Postman pour créer des tests initiaux, éliminant ainsi toute lacune dans la connaissance du produit.
• Pour faire face aux exigences manquantes, l'équipe du projet a construit la documentation de haut niveau sur le terrain à l'aide de Swagger. Cela a cependant laissé quelques lacunes en termes de formats de données acceptables et cela a été repris avec l'équipe du projet et les formats attendus ont été convenus et documentés.

Conclusion

Les applications basées sur l'API ont gagné en popularité ces derniers temps. Ces applications sont plus évolutives par rapport aux applications / logiciels traditionnels et permettent une intégration plus facile avec les autres API ou applications.

Ce didacticiel de test d'API a expliqué en détail tout sur les tests d'API, les tests de décalage vers la gauche, les services Web et l'API Web. Nous avons également exploré les différences entre les services Web et l'API Web avec des exemples.

Dans la deuxième partie du didacticiel, nous avons discuté du spectre complet des tests d'API, de la manière d'introduire les tests d'API dans votre organisation et de certains défis courants dans ce processus, ainsi que des solutions pour eux.

Consultez notre prochain tutoriel pour en savoir plus sur les services Web ainsi que des exemples !!

Tutoriel SUIVANT

lecture recommandée

• Test alpha et test bêta (un guide complet)
• Test fonctionnel vs test non fonctionnel
• Tutoriel de test d'utilisabilité: un guide de démarrage complet
• Build Verification Testing (BVT Testing) Guide complet
• Tutoriel de test DevOps: quel sera l'impact de DevOps sur les tests d'assurance qualité?
• Tutoriel de test d'accessibilité (un guide complet étape par étape)
• Meilleurs outils de test de logiciels 2021 (Outils d'automatisation des tests QA)
• Qu'est-ce que le test logiciel? Plus de 100 didacticiels de test manuels gratuits