Documenter les APIs avec Swagger (2/4) — Le framework Swagger [FRENCH]

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 :

  • Introduction,
  • Le framework Swagger,
  • La mise en scène de l’ensemble,
  • Le test de l’API.

Document the APIs with Swagger (1/4) - Introduction

In this series of articles, I will introduce the different Swagger tools. Swagger is a very handy tool for API documentation. It allows you to generate “living” documentation, so that the documentation is always up to date, which is very difficult to do without this kind of tool. It also allows to generate code automatically, allowing the developer to focus on his core business. Finally, it is based on an open source specification format.

These articles focus on Swagger 2.0, while the 3.0 version (“OpenAPI 3.0.0”) is available.

This article is thus broken down into four parts :

  • Introduction,
  • The Swagger framework,
  • Setting up the set,
  • The API test.

Documenter les APIs avec Swagger (1/4) - Introduction [FRENCH]

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.

Ces articles se concentrent sur Swagger 2.0, tandis que la version 3.0 (“OpenAPI 3.0.0”) est disponible.

Cet article est donc décomposé en quatre parties :

  • Introduction,
  • Le framework Swagger,
  • La mise en scène de l’ensemble,
  • Le test de l’API.
Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×