Quels types de contrats sont appliqués lors de la création d'une API REST?

Lors de la création d'une API REST, les types de contrats suivants sont utilisés:

• OpenAPI (Swagger) — norme pour décrire les API REST, permettant de documenter et de générer du code client.
• JSON Schema — définit la structure des objets JSON utilisés dans les requêtes et réponses.
• gRPC (bien que ce ne soit pas REST, il est parfois utilisé comme contrat pour l'API) — protocole avec contrat basé sur protobuf.

Dans le contexte des API REST, on utilise principalement OpenAPI, qui décrit:

• Les points d'accès (chemins et méthodes HTTP)
• Les formats de requêtes et de réponses
• Les paramètres et en-têtes
• Les codes de réponse

Exemple d'un fragment simple d'OpenAPI:

paths:
  /users:
    get:
      summary: Obtenir la liste des utilisateurs
      responses:
        '200':
          description: Réponse réussie
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'