Comment tester des API GraphQL sans coder
GraphQL s’impose comme une solution élégante pour un accès aux données flexible, découplé et dynamique. Mais comment bien le tester ?
Sur cette page

Dans cet article, nous replaçons GraphQL dans l’écosystème des API pour en comprendre l’histoire et les concepts clés.
Nous implémentons ensuite un cas de test concret d’API GraphQL avec le framework open source Cerberus Testing.
Pourquoi GraphQL s’impose#
Il faut d’abord revenir sur les grandes étapes de l’histoire des API.
Les API se sont surtout développées à l’ère de la SOA, portées par le protocole SOAP, fondé sur XML. Elles ont aidé les organisations à construire des services réutilisables, avec l’ambition d’une intégration plus simple qu’avec les générations précédentes. Les principaux défauts de SOAP tiennent à sa verbosité et à sa standardisation : la concurrence entre éditeurs a produit une multitude d’implémentations, au détriment de la simplicité d’intégration recherchée au départ.
C’est là que REST apparaît, comme une alternative légère et standard qui s’est largement imposée dans l’informatique. Tout un écosystème de documentation, d’outils comme swagger et de portails d’API a rendu possibles de véritables démarches « API-led » et la gestion des API à l’échelle de l’entreprise. En parallèle, les appareils mobiles remplaçaient peu à peu les ordinateurs de bureau traditionnels.
L’essor des applications mobiles a poussé à livrer ces applications plus vite et mieux. Pour les développeurs mobiles, l’intégration avec les API REST du back-end était une difficulté majeure, liée au couplage statique et technique entre le front-end et le back-end. C’est pour y répondre que des ingénieurs de Facebook ont conçu une solution plus élégante : GraphQL (s’ouvre dans un nouvel onglet).
Qu’est-ce que GraphQL ?#
GraphQL vise à simplifier l’intégration des consommateurs avec les API du back-end. Son principe clé : accéder dynamiquement à des modèles de données décrits, qui évoluent avec moins de couplage entre le consommateur et les producteurs de données.
Techniquement, GraphQL partage plusieurs caractéristiques avec les API REST :
- Il repose sur le protocole HTTP
- Il prend en charge les méthodes GET et POST
- Il utilise le format application/json
Les principales différences portent sur les mécanismes de récupération des données, qui étaient justement le problème à résoudre. Les éléments principaux de GraphQL sont query, operationName et variables. Ils permettent de composer des requêtes flexibles vers le back-end, ce qui simplifie le développement et l’exploitation des données. La réponse contient les éléments data et errors.
Passons maintenant aux tests.
Bonnes pratiques pour tester des API GraphQL#
Connaître les bonnes pratiques rend les tests d’API GraphQL plus efficaces.
Premièrement, évitez la méthode GET. GraphQL repose sur des mécanismes de requêtage dynamique fondés sur trois variables : POST est donc le standard de facto pour ce cas d’usage. Passer par GET serait trop complexe à mettre en place et à maintenir. Vous pourriez vous retrouver avec une requête de ce genre.
http://myapi/graphql?query%20aTest(%24arg1%3A%20String!)%20%7B%20test(who%3A%20%24arg1)%20%7DFaites défiler pour lire les lignes entières →
Les paramètres de requête en JSON et la compression Gzip comptent aussi, pour le développement comme pour les tests. JSON est en réalité optionnel dans le protocole, même si, en pratique, on tire parti de la puissance de JSON, largement éprouvée avec REST. La compression s’active avec les paramètres suivants.
Accept-Encoding: gzipFaites défiler pour lire les lignes entières →
Enfin, appliquez les bonnes pratiques classiques des API : une stratégie de versionnement qui permet des évolutions sans rupture, la gestion des cas null, le renvoi des seules données demandées et la pagination, pour les performances. Ces sujets sont standard et relèvent d’un cadre à définir dans votre organisation ; GraphQL, lui, fournit le protocole.
Et puisqu’on parle de framework, un framework de test peut aussi nous simplifier la vie.
Tester des API GraphQL avec un framework#
Nous utiliserons le framework Cerberus Testing et cette API GraphQL publique (s’ouvre dans un nouvel onglet), à partir de laquelle vous pourrez décliner de nombreux cas d’usage.
Prérequis : disposer d’une instance Cerberus Testing, installée par vos soins ou via l’une des offres disponibles.
Les 3 éléments clés à utiliser dans Cerberus Testing sont :
- Application : définissez les environnements de votre application sous test
- Service : configurez un appel d’API GraphQL réutilisable, avec ses en-têtes et ses paramètres
- Test Case : composez le cas de test lui-même, avec les étapes, actions et contrôles qui réalisent une vérification automatisée
La définition de l’application consiste à choisir le type d’application de service « SRV » et à définir vos couples pays / environnement. Toutes ces valeurs sont entièrement personnalisables dans les paramètres.
Passons à la définition du service : sélectionnez le type de service REST et la méthode POST.
Dernière étape de configuration : définir la requête et, le cas échéant, ses en-têtes dans les autres onglets. Voici une façon de remplir la requête JSON dans l’onglet « Request ».
Dès lors, vous pouvez vous appuyer sur le framework de cas de test, avec ses étapes, actions et contrôles, pour composer votre cas de test. L’action callService est celle à utiliser pour chaque appel GraphQL à effectuer. Vous pouvez ensuite utiliser les différents contrôles disponibles pour réaliser des vérifications statiques ou dynamiques.
Votre test peut s’exécuter dans les différents environnements que vous avez définis pour l’application, grâce aux différents mécanismes d’exécution disponibles.
Aller plus loin avec vos tests GraphQL#
La structure présentée ici peut s’appliquer à de nombreux cas d’usage, et passer à l’échelle.
Vous pouvez intégrer ces tests dans une campagne de test planifiée ou déclenchée depuis un pipeline CI/CD. En complément, la Data Library permet de récupérer des jeux de données dynamiques pour vos actions comme pour vos contrôles, afin de traiter des scénarios plus complexes et une matrice de couverture plus large.
Pour les API REST, suivez notre tutoriel de tests d’API REST et découvrez comment tester vos API sans coder.
Pour revenir au cas d’usage d’origine de GraphQL, vous pouvez exécuter des tests mobiles sur des appareils réels ou émulés, qui effectuent des appels GraphQL précis au cours de vos tests. Ces tests en boîte blanche sur toute la pile (« full-stack ») sont utiles pour les scénarios de tests fonctionnels et d’intégration.
C’est là toute la force d’un framework : vous arrêtez de coder et vous commencez à tester. Nous espérons que Cerberus Testing vous accompagnera dans votre démarche d’automatisation des tests. N’hésitez pas à commenter, à participer et à l’essayer. De nombreuses vidéos (s’ouvre dans un nouvel onglet) sont également disponibles.
Mettez une étoile au projet sur GitHub (s’ouvre dans un nouvel onglet) si cet article vous a plu 🙂


