Découvrez comment simplifier la documentation et la consommation de vos API REST grâce à Swagger.
Cette formation en vidéo vous permettra de maîtriser les fondamentaux de Swagger et de l'Open API Specification (OAS).
Vous apprendrez à :
- Créer des spécifications API claires et concises,
- Générer automatiquement de la documentation interactive,
- Tester vos API directement depuis la documentation,
- Intégrer Swagger dans votre cycle de développement.
Pourquoi Swagger ? Parce qu'il facilite la collaboration entre les équipes front-end et back-end, améliore la présentation et la compréhension de vos API.
Au programme de ce tuto Swagger : Documentez vos APIs
- Qu'est-ce que Swagger ? Introduction à l'Open API Specification et à ses avantages.
- Les bases de l'OAS : Structure, éléments clés, exemples concrets.
- Outils et frameworks : Présentation des principaux outils pour travailler avec Swagger (Swagger Php, Swagger UI).
En plus de découvrir l'environnement Swagger, vous apprendrez à écrire les annotions :
- GET sans paramètre,
- GET avec paramètre,
- POST,
- PUT,
- DELETE.
À la fin de cette formation, vous serez opérationnel pour pouvoir mettre en place une documentation complète pour vos API en utilisant Swagger. En termes de support, nous utiliserons les codes de l'API Rest que nous avions écrit ensemble au cours de mon tuto API Rest côté Backend.
Il est à préciser qu'il n'est pas nécessaire d'avoir vu ce tuto pour suivre cette formation sur Swagger, apprendre à documenter une API Rest.