Swagger

L'outil suivant que nous pouvons utiliser pour tester et déboguer notre application est le suivant Swagger. Nous nous sommes déjà familiarisés avec lui précédemment ; comme vous vous en souvenez, dans cet outil, vous pouvez voir tous les points de terminaison de l'application en cours de développement, les exécuter et obtenir le résultat. Voyons cela plus en détail.

Autorisation dans Swagger

Tout d'abord, rappelez-vous que Middleware Token Auth est activé par défaut, ce qui contrôle l'accès à l'endpoint pour la plupart des endpoints. Il refuse l'accès aux utilisateurs qui n'ont pas été autorisés ou même qui l'ont passé mais ne disposent pas des droits d'accès appropriés (par exemple, ils appartiennent au groupe Users, et le point de terminaison est destiné exclusivement à Admins).

Le jeton d'autorisation nécessaire peut être trouvé en utilisant le site Developer Tools. Il suffit de se connecter à l'application web publiée et de répondre à n'importe quelle demande. Le jeton sera utilisé dans l'application Request Headers. Par exemple, vous pouvez le voir sur la capture d'écran un peu plus haut au moment où nous avons fait une requête GET pour obtenir des données sur les pays.

Voyons comment vous pouvez l'obtenir directement dans . Swagger. Pour ce faire, trouvez le endpoint qui est responsable de l'autorisation (Auth groupe, POST /Auth/ endpoint) et cliquez sur le bouton "Try it out" ". Ce point de terminaison prend deux paramètres, Login, et Password. Indiquez-les et cliquez sur Execute pour envoyer la requête. A propos, ici, il peut aussi être utile d'utiliser les Developer Tools; vous pouvez les ouvrir pour une étude plus détaillée de la demande et de la réponse.

La réponse recevra le jeton requis, ainsi que des informations détaillées sur l'utilisateur et ses sessions.

Vous pouvez constater que la réponse reçue n'est pas très différente de celle que nous avons déjà vue sur le site Developer Tools. En même temps, l'outil d'envoi de la demande a un avantage indéniable, Swagger a un avantage indéniable : il permet de tester n'importe quelle requête et de lancer des endpoints avec les paramètres nécessaires sous une forme pratique. Mais avant de procéder à de tels tests, cliquons sur Authorize et utilisons le jeton reçu pour confirmer l'autorisation.

Envoyer des requêtes en utilisant Swagger

Maintenant, envoyons une requête à travers Swagger pour obtenir des données sur la première ville qui se présente, avec une population de plus de 5 millions d'habitants et le mot "World" dans la description. Pour ce faire, ouvrez le GET /city/ et remplissez les paramètres requis :

• _limit = 1 (une seule ville nécessaire)
• population_from = 5000000 (la valeur de la population doit être vérifiée)
• _search_in = info (recherche uniquement dans le champ info )
• _search = World (recherche du mot World)

La réponse reçue montre que la requête a été exécutée correctement. Nous avons reçu des informations sur une de ces villes (on voit que count = 3ce qui signifie que la base de données contient des informations sur trois villes appropriées) et n'a pas reçu de données sur le pays dans lequel elle est située (“country”: null), puisque la requête n'avait pas besoin de présenter des données provenant de tables connexes (si nécessaire, il était utile d'utiliser le paramètre _with ).