Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Changelog

Tous les changements sur le schéma ou le fonctionnement de l’API sont répertoriés dans ce document. Les changements techniques sont décrit dans ce document.

Politique de versionnement

Les besoins évoluent au fil du temps, et GraphQL permet à une API de s’adapter à ces besoins sans avoir à gérer différentes versions de l’API. Par exemple, si une nouvelle fonctionnalité nécessite la mise à disposition de valeurs de nom plus spécifiques, le type User pourrait être mis à jour comme suit :

type User {
  fullName: String
  nickname: String
  name: String @deprecated(reason: "Utilisez `fullName`.")
}

Les outils client peuvent alors encourager les développeurs à utiliser les nouveaux champs et à supprimer l’utilisation du champ name obsolète. Le champ peut être supprimé une fois établi qu’il n’est plus utilisé ; en attendant, GraphQL continuera à fournir ses données comme prévu.

Les API GraphQL ne sont usuellement pas versionnées. Cependant, ARISE a fait le choix d’ajouter un préfixe /v1 à l’endpoint GraphQL. Malgré les mécanismes décrit précédemment, il n’est pas simple de réussir le design d’une API du premier coup. Le passage de la version 0 à la version 1 s’est déroulé avec beaucoup de “breaking changes”, en maitrisant la version majeure nous avons pû réaliser la transition en douceur.

Si un jour une réécriture complète de l’API est à prévoir, ce préfixe permettra à nouveau une transition plus douce pour les sites associatifs ou même ceux d’ARISE.

1.0.0 - 2026-04-12

Mise en production de l’API