4.7/5 Trustpilot (1394 avis)
Bundle : API Rest de A à Z
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.
Qu’allez-vous apprendre dans ce cours ?
Plan de cours
Chapitre 1
Découvrir l'environnement swagger
Découvrir l'environnement swagger
Chapitre 2
Ecrire les annotations de base
Ecrire les annotations de base
Chapitre 3
Annotations GET sans paramètre
Annotations GET sans paramètre
Chapitre 4
Annotations GET avec paramètre
Annotations GET avec paramètre
Chapitre 5
Les schémas
Les schémas
Chapitre 6
Annotations POST
Annotations POST
Chapitre 7
Annotations PUT
Annotations PUT
Table des matières
Chapitre 1 : Découvrir l'environnement swagger
36m40
Leçon 1Présentation de l'environnement swagger
Leçon 2Présentation de l'API à documenter
Leçon 3Installer swagger-php
Leçon 4Générer un fichier json
Leçon 5Installer swagger-ui
Leçon 6Générer notre fichier de documentation
Leçon 7Afficher le contenu de notre fichier json
Chapitre 2 : Ecrire les annotations de base
11m13
Leçon 1Déclarer toutes les infos de la documentation
Leçon 2Déclarer le serveur
Chapitre 3 : Annotations GET sans paramètre
19m25
Leçon 1Déclarer les annotations du chemin /readAll
Leçon 2Déclarer un tag
Leçon 3Tester l'url
Chapitre 4 : Annotations GET avec paramètre
06m54
Leçon 1Déclarer les annotations du chemin /read/{tutoID}
Chapitre 5 : Les schémas
24m51
Leçon 1Déclarer un schéma
Leçon 2Comprendre le fichier Json
Leçon 3Relier le schéma à la route /read/{tutoID}
Leçon 4Relier le schéma à la route /readAll
Chapitre 6 : Annotations POST
18m42
Leçon 1Déclarer les annotations du chemin /create
Leçon 2Définir les codes de réponse
Leçon 3Insérer des datas
Chapitre 7 : Annotations PUT
05m07
Leçon 1Modifier des datas
Chapitre 8 : Annotations DELETE
03m51
Leçon 1Supprimer des datas
Chapitre 9 : Conclusion
03m26
Leçon 1Bilan de ce que nous avons appris
Chapitre 10 : Protéger sa base de données
19m51
Leçon 1Déclarer un serveur de démo
Leçon 2Rendre impossible la suppression de certains enregistrements
Leçon 3Rendre impossible la modification de certains enregistrements
Leçon 4Simuler les insertions
Avis des apprenants