Concepts fondamentaux de l'API

Schéma et types

Le schéma décrit tout ce que l'API expose : types, champs et arguments. C'est la référence pour construire vos requêtes. La documentation « GraphQL Schema » de ce site est générée à partir de ce schéma : vous y retrouvez les opérations (queries, mutations) et tous les types (objets, inputs, scalaires).

Queries et Mutations

• Queries : pour lire des données (équivalent de GET en REST). Elles sont idempotentes et sans effet de bord.
• Mutations : pour créer, modifier ou supprimer des données. À utiliser dès que vous changez l'état côté serveur.

Exemple de query (lecture) :

query {
  rentalFoldersPaginated(page: 1, pageSize: 10) {
    data {
      id
      comment
    }
    meta {
      currentPage
      hasNextPage
      totalCount
    }
  }
}

Pour une mutation, la forme est la même en remplaçant query par mutation et en passant des variables (ex. $input) dans le corps de la requête.

Subscriptions

Si l'API le propose, les subscriptions permettent de recevoir des mises à jour en temps réel (souvent via WebSocket). Consultez le schéma pour voir si des subscriptions sont exposées et comment les utiliser.

Filtres et arguments

Les queries et mutations acceptent des arguments : filtres, tri, pagination (ex. page, pageSize), identifiants. Les types input et les arguments sont décrits dans le schéma ; utilisez-les pour cibler précisément les données dont vous avez besoin.