Documenter les APIs avec Swagger (1/4) — Introduction
Dans cette série d’articles, je vais introduire les différents outils de Swagger. Swagger est un outil très pratique de documentation des APIs. Il permet de générer de la documentation “vivante”, permettant ainsi que la documentation soit toujours à jour, ce qui est très difficile à réaliser sans ce genre d’outil. Il permet également de générer du code automatiquement, permettant au développeur de se concentrer sur le coeur de son activité. Enfin, il repose sur un format de spécifications open source.
Cet article est donc décomposé en quatre parties :
La spécification OpenAPI (OAS — OpenAPI Specification) (https://www.openapis.org/) permet de découvrir les fonctionnalités d’un service sans avoir de détails sur le code utilisé pour implémenter l’API.
C’est une interface Open Source indépendante du langage utilisé pour créer l’API REST créée dans le cadre de Linux Foundation.
Le cas d’usage est qu’après avoir écrit la spécification OpenAPI, vous disposez d’une documentation interactive de l’API.
La spécification peut être écrite en YAML ou en JSON.
La spécification Swagger est disponible à l’adresse https://Swagger.io/specification.
