Les API font partie intégrante du travail de tout développeur web et une chose est sûre : elles sont de plus en plus nombreuses et de plus en plus complexes avec une multitude de façon de s'y authentifier (Oauth, clé API, token), de headers à gérer, de cookies, d'environnements (local, développement, intégration, recette, production), etc.
Avant de commencer le développement et de coder un quelconque connecteur à une API tierce pour une nouvelle fonctionnalité dans votre application, il peut être très avantageux de s'assurer du bon fonctionnement de la-dite API. Dans une optique similaire, pour notre propre API cette fois-ci, on peut imaginer un processus de conception & développement dans lequel l'ensemble des requêtes nécessaires à la création d'une nouvelle fonctionnalité soit créées en amont du développement avec des tests afin de valider les signatures et la sécurité des endpoints.
Plusieurs solutions sont disponibles : Insomnia, l'extension VSCode "REST Client", Paw... L'une des applications les plus populaires, et celle sur laquelle nous allons nous pencher est Postman. Elle permet de créer des requêtes très rapidement, de gérer et maintenir des collections en équipe et de créer des cas de test et scénarios.
Cette introduction prendra la forme de plusieurs chapitres constitués d'une page chacun et démontrant une notion ou un thème par l'exemple. Une collection et un environnement sont également téléchargeables et importables dans Postman afin que les explications puissent être suivies directement sur l'application de bureau.
L'API sur laquelle se basera cette introduction est l'API conseillée par Postman pour tester l'outil et sa documentation se trouve ici : https://postman-echo.com
- Avoir téléchargé Postman
- Notions basiques de Javascript pour l'écriture des tests
- Notions basiques du protocole HTTP
- Notions basiques des APIs RESTful et du format JSON
- 0 - Comment importer la collection et l'environnement de cette introduction
- 1 - Requêtes et collections
- 2 - Variables et environnements
- 3 - Les scripts et les tests (basique)
- 4 - Les scripts et les tests (intermédiaire)
- 5 - Les scripts et les tests (avancé)
- 6 - Le Runner