Mudanças de API
Mudanças incompatíveis, descontinuações e versionamento, explicados para quem é afetado.
-
Versionamento da API do Stripe: como funciona e o que copiar
O versionamento da API do Stripe fixa cada conta em uma versão com data e permite sobrescrevê-la por requisição. Como funciona, o custo e o que copiar.
Mudanças de API8 min de leitura
-
Protobuf breaking changes: o que sobrevive no fio
Protobuf breaking changes acontecem no fio, não na URL. Mudanças de campo gRPC são grátis, outras quebram todo cliente em silêncio, mas parecem iguais.
Mudanças de API6 min de leitura
-
Mudanças de schema no GraphQL: depreciação sem versão
O GraphQL não tem v1 nem v2 na URL. Campos são depreciados um a um com uma diretiva, em um único schema compartilhado, e isso muda o que um changelog deve.
Mudanças de API6 min de leitura
-
Como escrever um guia de migração de API
Um guia de migração de API transforma uma mudança incompatível em checklist, não em interrupção. O que ele precisa ter, e por que uma entrada não basta.
Mudanças de API5 min de leitura
-
Changelogs de API internas: o que muda para o outro time
Um changelog de API pública tem um público que você não consegue contatar. Um interno tem um público a dois andares, e isso muda o que se deve a ele.
Mudanças de API6 min de leitura
-
Changelogs de webhook: o breaking change que ninguém pediu
Uma mudança no payload de um webhook quebra em silêncio, porque não há quem a rejeite. O que torna uma mudança de payload quebradora, e como versioná-la.
Mudanças de API6 min de leitura
-
O header Sunset da API, e quando enviar um
O header Sunset da API diz quando uma versão vai parar de responder, diferente de um aviso de depreciação. O que a RFC 8594 cobre e o que um brownout traz.
Mudanças de API6 min de leitura
-
Changelog de API: o que publicar e quem lê
Um changelog de API é lido por quem decide se o próprio código ainda vai funcionar no mês seguinte. O que cada entrada deve, onde ele vive e como assinar.
Mudanças de API7 min de leitura
-
Como depreciar uma API sem perder seus desenvolvedores
Depreciação é uma promessa com uma data. O cronograma, o modelo de aviso, os headers de resposta, e o passo que impede um sunset de virar incidente.
Mudanças de API7 min de leitura
-
Melhores práticas de versionamento de API, para chamadores
Versione só o que quebra algo, coloque a versão onde os chamadores a vejam, e mantenha a antiga funcionando até uma data. Quatro esquemas comparados.
Mudanças de API8 min de leitura
-
Mudanças que quebram algo: o que conta e como lançá-las
Uma mudança que quebra algo é qualquer uma que um chamador correto não suportaria. O que conta, o que não conta, como pegá-la no CI e como lançá-la.
Mudanças de API10 min de leitura
