Changements d'API
Changements incompatibles, dépréciations et versions, expliqués à ceux qu'ils concernent.
-
Versionnage de l'API Stripe : fonctionnement et à copier
Le versionnage de l'API Stripe épingle chaque compte sur une version datée et laisse chaque requête la changer. Fonctionnement, coût, ce qu'on peut copier.
Changements d'API8 min de lecture
-
Changements cassants Protobuf : ce qui survit sur le fil
Les changements cassants Protobuf se jouent sur le fil, pas dans l'URL. Certains changements gRPC sont gratuits, d'autres cassent chaque client en silence.
Changements d'API7 min de lecture
-
Dépréciation GraphQL sans numéro de version
GraphQL n'a pas de v1 ni v2 dans l'URL. Les champs sont dépréciés un par un via une directive, dans un schéma commun, et cela change le changelog.
Changements d'API6 min de lecture
-
Comment écrire un guide de migration d'API
Un guide de migration d'API transforme un changement incompatible en checklist. Ce qu'il doit contenir, et pourquoi une entrée de changelog ne suffit pas.
Changements d'API6 min de lecture
-
Changelogs d'API internes : ce qui change
Un changelog d'API publique a un public qu'on ne peut pas contacter directement. Un interne a un public à deux étages, et ça change ce qu'on lui doit.
Changements d'API6 min de lecture
-
L'en-tête sunset d'API, et quand l'envoyer
L'en-tête sunset d'API dit quand une version cessera de répondre, à la différence d'une dépréciation. Ce que couvre la RFC 8594, ce qu'apporte un brownout.
Changements d'API6 min de lecture
-
Changelogs de webhooks : le changement cassant non demandé
Un changement de payload de webhook casse en silence, car personne ne peut le rejeter. Ce qui rend ce changement cassant, et comment le versionner.
Changements d'API6 min de lecture
-
Changelog d'API : quoi publier et qui le lit
Un changelog d'API est lu par des gens qui décident si leur code marchera encore le mois prochain. Ce que doit chaque entrée, où il vit, comment suivre.
Changements d'API7 min de lecture
-
Comment déprécier une API sans perdre ses développeurs
La dépréciation est une promesse avec une date. Le calendrier, le modèle d'avis, les en-têtes de réponse, et l'étape qui évite un incident au sunset.
Changements d'API7 min de lecture
-
Bonnes pratiques de versionnage d'API, pour les appelants
Versionnez seulement ce qui casse, mettez la version où les appelants la voient, et gardez l'ancienne active jusqu'à une date. Quatre schémas comparés.
Changements d'API8 min de lecture
-
Changements cassants : ce qui compte, comment en livrer un
Un changement cassant est tout changement qu'un appelant correct ne pourrait pas survivre. Ce qui compte, ce qui ne compte pas, comment le repérer en CI.
Changements d'API10 min de lecture