Gestao do ciclo de vida de API

Cuidar de uma API do desenho ate a aposentadoria, passando por versao, documentacao e monitoramento.

Hard

O que é

Gestao do ciclo de vida de API e tudo que acontece com uma API desde o primeiro desenho ate o momento em que ela e desligada. Isso inclui o versionamento (pra nao quebrar quem ja usa), a documentacao (pra quem integra entender), a seguranca, o monitoramento de desempenho e o plano de descontinuar uma versao antiga com aviso.

Pra produto, ate quem nao programa precisa entender o basico, porque hoje a API tambem e produto. Afinal, tem cliente do outro lado (a gente que integra), tem uma promessa de estabilidade e tem custo quando algo muda. Quebrar uma versao sem aviso e como mudar o produto debaixo do pe de quem depende dele.

O ponto pratico e tratar a API com o mesmo cuidado de uma tela: contrato claro, documentacao usavel e transicao com prazo, nunca surpresa.

Em uma frase

Antes de aposentar a v1, vamos avisar os parceiros com prazo pra ninguém ser pego de surpresa.

A pergunta que ele responde

Como eu evoluo uma API sem quebrar quem já depende dela do outro lado?

Quando usar

Ajuda quando a API tem clientes externos e precisa evoluir sem quebrar a integracao que ja existe.

Como não usar

O cuidado e nao mudar ou desligar uma versao sem aviso, achando que quem integra vai dar um jeito sozinho.

Na prática

Imagine um time que da seis meses de aviso antes de aposentar a versao 1 da API, pra que os parceiros consigam migrar sem susto.

Não confunda com

Vale separar a gestao do ciclo de vida de API do simples ato de construir a API. Construir e o comeco, ja gerir e manter, versionar e aposentar sem quebrar quem depende daquilo.

Em inglês

API Lifecycle Management

Pronúncia

ei-pi-ai

Também chamado de

ciclo de vida de API, gestao de API

Origem

n/a

Fonte

Saiba mais

Google, API Design Guide