Aller au contenu principal
FONCTIONNALITÉ 08 / 11

Un changelog d’API, calculé dans le navigateur du lecteur.

Quand un schéma évolue, le lecteur qui revient veut une chose : ce qui a bougé depuis son dernier passage. ApiGlow garde une empreinte des opérations que chaque lecteur a vues — dans son propre navigateur — et compare le document chargé à cette empreinte. Pas de service de changelog, pas de compte, rien d’envoyé nulle part.

demo.apiglow.dev/#/overview · petstore.yaml
Le panneau des changements de schéma : trois opérations ajoutées, deux modifiées, comparées au schéma vu lors de la dernière visite. Le panneau des changements de schéma : trois opérations ajoutées, deux modifiées, comparées au schéma vu lors de la dernière visite.

CAPTURE RÉELLE, AFFICHÉE À 1:1

Quoi de neuf depuis votre dernière visite.

Au chargement, le document est comparé à l’instantané stocké chez le lecteur. Une fenêtre liste les opérations ajoutées, retirées et modifiées depuis — avec les versions du schéma et la date de ce dernier passage. L’ouvrir une fois marque la différence comme vue ; le prochain changelog repartira de là.
La fenêtre des changements de schéma listant trois opérations ajoutées et deux modifiées. La fenêtre des changements de schéma listant trois opérations ajoutées et deux modifiées.
[01]CE QUI A BOUGÉ DEPUIS LA DERNIÈRE VISITE

Les badges disent où.

La fenêtre dit quoi ; les badges disent où. Les opérations ajoutées et modifiées portent une marque dans la navigation — sur l’opération et sur son groupe — et dans le contenu de la doc, chacune avec infobulle et nom accessible, jamais la couleur seule. Un lecteur qui balaie la navigation voit les nouveautés sans rien ouvrir.

Aucun service derrière.

La différence est calculée côté client à partir d’empreintes d’opérations stockées dans l’IndexedDB du lecteur, par URL de schéma — des instantanés compacts, pas des copies du schéma, plafonnés en LRU pour que le stockage reste borné. Le changelog de chaque lecteur est vraiment le sien : il compare à sa dernière visite, pas à une date de publication que vous maintenez. Rien à héberger, rien à configurer.

Il se marie naturellement avec l’audit — l’un note le document, l’autre suit son mouvement — et avec les overlays, dont les corrections apparaissent comme des changements parmi les autres.

Une aide à la lecture, pas un audit de contrat.

La comparaison porte sur des empreintes bornées : un changement enfoui sous le budget de profondeur n’est pas signalé, une première visite n’a rien à quoi comparer, et un instantané évincé coûte simplement un changelog. Pour des garanties de contrat, comparez les fichiers de schéma en CI ; cette fonctionnalité est pour les lecteurs, pas pour les pipelines.