Swagger ou comment tester son APi sans utiliser Postman.

Ecrit par Baptiste Janin

Tout le monde connait surement le logiciel Postman qui permet de tester sa WebApi, mais Swagger permet lui de tester et de voir les endpoints disponibles sur le projet.

Pour commencer il faut installer et initialiser Swagger sur son projet:

1. Installer le package Nugget: Swashbuckle

Ou utiliser la commande

PM> Install-Package Swashbuckle.AspNetCore

2. Configurer le Swagger dans le Startup du projet:

Une fois que c’est fait il ne reste plus qu’à lancer le projet et à utiliser Swagger. Swagger va automatiquement ajouter tout les endpoints du projet sur sa page de lancement en les regroupant par Controleur et en affectant une couleur différentes suivant s’il s’agit d’un Get, d’un Post, d’un Put ou d’un Delete.

Quelques exemples d’utilisation de Swagger

Test d’un Get simple avec juste un paramètre:

Maintenant lançons l’application.

Il suffit de cliquer sur ”Try it out”, de remplir le champ ”test“ et de cliquer sur le bouton ”Execute” qui va apparaitre et voici le résultat qui va s’afficher:

Test d’un Get avec deux paramètres

Maintenant lançons l’application.

Il suffit de cliquer sur ”Try it out”, de remplir le champ ”test“ et ”ici” et de cliquer sur le bouton ”Execute” qui va apparaitre et voici le résultat qui va s’afficher:

Test d’un Get avec un paramètre et un query paramètre

Maintenant lançons l’application.

Il suffit de cliquer sur ”Try it out”, de remplir le champ ”test“ et ”type” et de cliquer sur le bouton ”Execute” qui va apparaitre et voici le résultat qui va s’afficher:

Test d’un Post avec un l’upload d’un fichier

Maintenant lançons l’application.

Il suffit de cliquer sur ”Try it out”, de remplir le champ ”test“ , de mettre un fichier dans le ”fil” et de cliquer sur le bouton ”Execute” qui va apparaitre et voici le résultat qui va s’afficher:

On peut voir dans la partie “Responses” qui s’affiche après chaque appel, l’url de la requête que Swagger reconstitue à partir des infos du projet et des paramètres que l’on a remplit.

Lien de téléchargement => https://swagger.io/tools/swagger-ui/download/