À quoi sert Swagger?

Swagger (maintenant OpenAPI Specification) est utilisé pour décrire, documenter et visualiser les API RESTful. Cela permet aux développeurs, testeurs et consommateurs d'API de comprendre la fonctionnalité du service sans accès au code source.

Fonctions principales:

1. Documentation: Création automatique d'une documentation interactive de l'API.
2. Développement: Aide au développement de l'API en fournissant une définition claire du contrat.
3. Test: L'interface Swagger (Swagger UI) permet de tester directement les points d'extrémité de l'API depuis le navigateur.
4. Génération de code: Il est possible de générer du code client (SDK) ou des stubs serveur à partir de la spécification OpenAPI.
5. Conception: Peut être utilisé comme un outil pour concevoir l'API avant de commencer à coder (Approche Design-First).

Exemple de fragment de spécification en format YAML:

# Brève description de l'API
openapi: 3.0.0
info:
  title: Mon API de test
  version: 1.0.0
paths:
  /items:
    get:
      summary: Obtenir la liste de tous les éléments
      responses:
        '200':
          description: La liste des éléments a été obtenue avec succès
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Item'
components:
  schemas:
    Item:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string

Cela garantit la cohérence entre les différentes parties impliquées dans le développement et l'utilisation de l'API.