Comment construire un framework d’automatisation des tests d’API
Votre équipe a commencé à développer tout un ensemble d’API. Si elles semblent prometteuses pour le métier, elles vous posent un nouveau défi : les tester. Les tests manuels suffisent dans certains cas, mais l’automatisation devient vite indispensable.
Sur cette page

Bien automatiser les tests d’API demande une structure qui encadre leur mise en œuvre. C’est tout l’objet d’un framework : fournir un cadre de référence reproductible pour résoudre un ensemble de problèmes.
Dans notre cas, nous voulons automatiser des tests d’API de bout en bout alignés sur les exigences métier, tout en garantissant leur accessibilité, leur maintenabilité et leur scalabilité.
Cet article présente les caractéristiques communes d’un framework d’automatisation des tests d’API de bout en bout, en montrant leur mise en œuvre dans Cerberus Testing. Voici les points abordés :
- Pourquoi construire un framework de tests d’API ?
- Qu’est-ce qu’un framework de tests d’API utile ?
- Les personas et les cas d’usage d’un framework de tests d’API
- Construire une bibliothèque d’API réutilisable et scalable
- Écrire les tests en low-code avec des mots-clés partagés
- Exécuter les tests d’API rapidement et de manière fiable
- Apporter la traçabilité et la visibilité nécessaires
- Faire passer vos tests d’API à l’échelle grâce au framework
Commençons par nous accorder sur le pourquoi avant d’entrer dans les détails de mise en œuvre.
Pourquoi construire un framework de tests d’API ?#
API signifie Application Programming Interface (interface de programmation d’application). Les API font le pont pour échanger des données et exécuter des fonctions. L’essor des systèmes distribués a considérablement accru leur maturité et leur usage dans les organisations.
Les API sont aujourd’hui la pierre angulaire de la transformation numérique des entreprises et de la numérisation de leurs activités. Elles permettent de construire rapidement une expérience utilisateur en s’appuyant sur des services back-end prêts à l’emploi, publiés sous forme d’API. De même, elles ont accéléré la réutilisation des services back-end par composition.
Les API ont beaucoup mûri depuis les premiers échanges de fichiers et les protocoles RPC et SOAP. Des protocoles plus légers, plus ouverts et standardisés sont apparus pour répondre à des besoins précis, comme REST, GraphQL et gRPC.
Les API sont désormais vitales pour la survie des entreprises. Elles leur permettent de s’intégrer avec leurs partenaires et sont au cœur de l’exécution des opérations métier. Ces API critiques peuvent s’appuyer sur l’automatisation des tests pour sécuriser leur livraison.
Voyons maintenant les éléments d’un framework d’automatisation des tests d’API.
Qu’est-ce qu’un framework de tests d’API utile ?#
Dès que l’on décide d’automatiser les tests de ses API, les questions se multiplient. Que tester ? Comment définir les tests ? Comment les exécuter ? Comment réutiliser et étendre notre approche ? Le framework est là pour y répondre.
Notre framework doit apporter de la valeur à ses utilisateurs, pas au logiciel testé lui-même. Notre première priorité est donc de définir clairement les cas d’usage des acteurs de l’automatisation des tests d’API. Traditionnellement, le produit, le développement et les opérations sont concernés.
« Notre framework doit apporter de la valeur à ses utilisateurs, pas au logiciel testé lui-même. »
Antoine CraskeL’accessibilité du framework et la collaboration qu’il permet sont donc une exigence essentielle. On l’oublie facilement quand on se précipite pour coder un test d’API précis. À partir du cas d’usage de chaque acteur, on peut ensuite descendre jusqu’aux fonctions à fournir.
L’objectif global d’un framework est de résoudre le problème métier initial : garantir une livraison rapide et reproductible d’API utiles. Notre automatisation des tests doit donc offrir des boucles de feedback rapides pour que l’équipe puisse itérer sur la valeur livrée.
La valeur métier de notre framework dépendra du contexte. Les métriques DORA (s’ouvre dans un nouvel onglet) — délai de livraison (lead time), taux d’échec des changements, MTTA et MTTR — restent néanmoins tout à fait pertinentes pour mesurer notre impact au bout du compte.
Voyons les besoins des différents personas.
Les personas et les cas d’usage d’un framework de tests d’API#
L’équipe produit veut généralement s’assurer d’un comportement de bout en bout précis de l’expérience utilisateur ou des opérations métier. Il lui faut donc un référentiel de tests partagé et compréhensible, avec un accès au reporting des différents tests d’API.
Ce sont les développeurs qui corrigeront les problèmes d’API. Leurs besoins principaux : une exécution rapide, de la traçabilité et des tests reproductibles. Quand un bug leur est affecté, ils doivent vite retrouver l’API et le problème, livrer une modification et vérifier qu’elle fonctionne.
Une remarque au passage : si les développeurs doivent aider à configurer les API, c’est un signal d’alerte sur l’accessibilité de ces API. Hélas, constater à la main qu’une API est difficile à comprendre est déjà une forme de test, qui ne demande aucune automatisation.
Les opérations ont, comme l’équipe produit, besoin d’une visibilité d’ensemble. Et, comme les développeurs, elles doivent pouvoir descendre dans la vue technique et le rapport pour accélérer la résolution.
Passons maintenant à la mise en œuvre. L’exemple s’appuie sur REST et GraphQL, pour tester une API isolée mais aussi pour un test de bout en bout qui vérifie à la fois des éléments web et API.
Le premier socle consiste à disposer de composants d’API réutilisables.
Construire une bibliothèque d’API réutilisable et scalable#
Une bibliothèque d’API nous aide à gérer la complexité qui ne manquera pas d’arriver. On commence par tester une API dans un environnement, puis dans tous les environnements, puis pour différents pays. Et l’histoire se répète pour valider d’autres cas d’usage et d’autres API.
Une bibliothèque d’API sert à contenir la complexité de l’application à tester. Elle regroupe la définition des différentes API : endpoints, paramètres et informations de connexion spécifiques.
Son intérêt est d’isoler nos tests des détails de configuration. On découple la définition de l’API de son test. Ainsi, toute modification de la définition d’une API ne demande qu’un seul changement, sans impact sur les cas de test.
Par exemple, s’il faut ajouter un nouvel environnement à l’API, cela se fait à un seul endroit. Idem pour ajouter un pays, ou pour changer une authentification par jeton fixe, de type Bearer.
Passons à la définition des tests d’API.
Écrire les tests en low-code avec des mots-clés partagés#
La structure de nos tests d’API peut suivre le format « given, when, then ». Ils sont ainsi plus accessibles, puisqu’il s’agit d’une pratique standard, et peuvent s’intégrer à d’autres tests pour répondre au besoin de bout en bout. Avant de coder, n’oubliez pas nos personas.
Nous avons vu que l’accessibilité et la facilité d’utilisation sont des exigences clés. Elles se traduisent par une structure de test pilotée par mots-clés (keyword-driven), en low-code, disponible dans une interface web pour favoriser la collaboration.
Une fois la structure de nos cas de test définie, il faut l’enrichir pour couvrir des cas d’usage plus avancés. Le premier : gérer des propriétés dynamiques, par exemple pour récupérer un jeu de données depuis un autre système. Cela demande aussi de mettre en œuvre des techniques de tests pilotés par les données (data-driven) (s’ouvre dans un nouvel onglet).
La définition des contrôles est un point douloureux classique, encore plus avec les API : il faut trouver le chemin, chercher des éléments, analyser toute la réponse. Une bonne pratique consiste à fournir un parseur dédié. Dans Cerberus Testing, c’est possible avec une expression « $.<element> » et l’action getFromJson (s’ouvre dans un nouvel onglet).
Il reste ensuite à fournir la capacité d’exécution.
Exécuter les tests d’API rapidement et de manière fiable#
L’exécution des tests d’API doit permettre des boucles de feedback rapides et fiables. On y parvient en proposant des suites de tests à lancer sur un moteur d’exécution parallèle doté de fonctions de fiabilité intégrées.
Une suite de tests est un regroupement logique de tests. Elle prend tout son sens quand le nombre de tests augmente et qu’il faut en exécuter plusieurs pour connaître l’état précis d’un système. Autre avantage : exécuter uniquement ce que l’on veut, pour un besoin donné.
Une fois que l’on sait quoi exécuter, reste l’exécution elle-même. L’approche la plus simple serait de lancer les tests les uns après les autres. En réalité, nos utilisateurs n’accepteront pas des boucles de feedback lentes : l’exécution parallèle des tests d’API est indispensable.
Exécuter un test n’a rien d’un long fleuve tranquille. Comme pour nos logiciels métier, le réseau peut tomber ou l’API être temporairement indisponible. Il faut gérer ces aléas dès la conception, avec des fonctions de fiabilité comme les relances automatiques avec temporisation progressive (back-off).
Notre travail n’est pas encore terminé : nos utilisateurs veulent savoir ce qui se passe.
Apporter la traçabilité et la visibilité nécessaires#
L’enjeu de l’observabilité s’applique aussi à nos tests automatisés. Nos utilisateurs veulent connaître l’état global de la campagne tout en pouvant zoomer sur chaque action et chaque contrôle effectués. L’attrait visuel des résultats compte aussi.
Accepteriez-vous un export CSV pour consulter votre compte bancaire ? Plus maintenant. Nos utilisateurs ont la même exigence pour la visualisation des tests automatisés. Une page web statique ne suffit pas : ils veulent de beaux graphiques qui leur permettent d’explorer les données.
Le premier niveau d’information se situe au niveau du cas de test. Il faut conserver une trace et les journaux des actions et contrôles effectués, ainsi que des éléments de contexte comme l’environnement, les temps d’exécution, etc. Nos utilisateurs connaissent ainsi directement le statut des étapes concernées.
Avec un peu de recul, l’équipe veut vite répondre à une question : « Pouvons-nous déployer nos changements en production pour nos utilisateurs finaux ? » Elle a besoin de connaître la santé globale de la campagne de test grâce à des indicateurs clés, ainsi que le statut de chaque cas de test de la suite exécutée.
Un ratio classique à fournir est le taux d’instabilité (flakiness). Il mesure la stabilité des tests en pourcentage, ce qui permet de suivre la tendance et de repérer les tests instables. Viser des tests stables est essentiel pour garder des boucles de feedback rapides auxquelles l’équipe peut se fier. L’équipe finira par ignorer une campagne qui échoue souvent et dure longtemps.
Si les étapes précédentes sont bien menées, nous sommes prêts à étendre l’automatisation de nos tests d’API.
Faire passer vos tests d’API à l’échelle grâce au framework#
Nous avons parcouru la construction d’un framework de tests d’API à travers le prisme d’une seule application. En entreprise, la réalité compte de nombreuses API, réparties entre plusieurs équipes, pour répondre à des cas d’usage métier variés. C’est là qu’un framework apporte une valeur supplémentaire.
Inversons la situation : que se passerait-il sans framework partagé ? Chaque équipe, voire chaque testeur, implémenterait les tests à sa manière. Même en répondant en partie aux mêmes besoins, leurs implémentations divergeraient, sans intégration ni interopérabilité.
Un framework apporte donc de la valeur d’abord en étant utile à ses premiers utilisateurs, et en pouvant être partagé dans toute l’entreprise. Un vrai framework est un produit que l’on fait évoluer, comme les services métier proposés aux utilisateurs finaux.
Un framework utile ne se construit pas du jour au lendemain : il est le fruit d’une amélioration continue, itération après itération. Cerberus Testing est un produit qui offre nativement les fonctionnalités présentées ici, y compris les tests de bout en bout.
Envie d’en savoir plus ? Vous pouvez l’utiliser gratuitement : commencez maintenant.
Voir la vidéo complète ici
https://www.youtube.com/watch?v=j1qnFaHr59I (s’ouvre dans un nouvel onglet)
Références#
Alexandre Mohr (2018), How to Achieve Collaboration as a Key Driver for Continuous Testing. 2018.
Antoine Craske (2021), Automate REST APIs Test with Cerberus Testing Framework. Cerberus Testing.
Antoine Craske (2021), Outil de Test: Automatisation avec Cerberus Testing. La Taverne Du Testeur.


