Swagger de l'API du TP

Utilisable ici => Swagger/documentation de l'API

Attention ⚠

Vous devez être sur le réseau du cégep ou connecté à votre VPN pour pouvoir accéder au Swagger de l'API.

Qu'est-ce que le Swagger?

Il s'agit d'un outil de visualisation et de tests des différentes routes d'un API. Il est constitué de 2 sections :

1. La description des routes ainsi que les différents paramètres d'entrées et de sorties. Il est possible d'agrandir chaque section des routes afin de voir les différents paramètres d'entrées et de sorties.

2. La description des schemasutilisés dans les différentes routes. Un schema est une description d'un objet JSON utilisé dans les différentes routes. Il est possible d'agrandir chaque section des schemas afin de voir les différents champs de l'objet JSON. Il est important de s'y référer afin d'avoir plus d'informations sur les différents champs d'un objet JSON.

Authentification

Il est possible de s'authentifier afin de pouvoir utiliser les routes du Swagger. Il suffit de cliquer sur le bouton et d'utiliser votre numéro de DA. Ensuite, vous serez en mesure de tester les différentes routes. Sinon, vous allez avoir un message d'erreur.