O Manual do API Life Cycle Mixer: O que é necessário para uma única fonte de verdade?

Por: Ariel DiFelice em 9 de junho de 2023

No bartender, o manual do mixer é uma fonte confiável de informações. Esses livros podem conter centenas de receitas de coquetéis clássicos, alguns dos quais podem ter 100 anos, enquanto outros podem ser para bebidas que só recentemente entraram em cena. Os manuais do misturador também podem ser ótimas fontes de inspiração para novas receitas ainda a serem testadas para adições emocionantes às ofertas de um bar ou restaurante. Esse ato de equilíbrio de preservar o antigo enquanto incentiva a exploração do novo pode fornecer uma lição valiosa para o desenvolvimento de APIs no mundo do software. A "única fonte de verdade" de uma API é, de muitas maneiras, o manual do próprio mixer da organização de software. Isso é especialmente verdadeiro quando a abordagem correta é adotada para garantir que o software permaneça funcional e com bom desempenho e forneça experiências que encantam os clientes e os fazem voltar para mais.

Embora possamos pensar em mixologia e nos mixologistas que praticam esse ofício como termos relativamente novos, o primeiro uso registrado da palavra "mixologista" remonta a 1852 e "mixologia" surgiu logo depois.

Quão semelhantes são os trabalhos, mentalidades e paixões de mixologistas e desenvolvedores e designers de API? Confira esta definição de mixologista e conte as semelhanças por si mesmo:

"O termo 'mixologista' se refere a alguém que estuda a história das bebidas mistas, tem uma rica apreciação dos ingredientes e técnicas usadas e cria regularmente bebidas mistas novas e inovadoras... as cenas, criando novos coquetéis artesanais e colocando seu toque de assinatura nos favoritos existentes."

Os melhores desenvolvedores de API, designers e arquitetos do mundo devem reconhecer muito do que foi dito acima em seu próprio trabalho. Eles têm profundo respeito por seu ofício e estão sempre aprimorando-o ainda mais. Buscam entender os gostos e paladares de seus consumidores. Eles consideram as entradas de outras partes interessadas, testam, iteram e testam suas criações novamente antes de "servir" essas APIs para produção.

Como mixologistas e bartenders (se você os vê como duas funções diferentes), todo profissional ao longo do ciclo de vida da API deve entender as necessidades dos consumidores, clientes e negócios - e então projetar e desenvolver suas APIs de acordo. Uma parte essencial deste processo é a contínua validação e adaptação às exigências do mercado.

Alterações nas APIs, mesmo as menores, podem ter efeitos downstream significativos. E o mesmo pode ser dito sobre ajustes feitos em uma receita antiga de coquetel, onde adicionar ou remover uma única pitada disso ou daquilo pode mudar completamente o sabor de uma bebida … assim como o interesse das pessoas por ela.

Embora não haja uma taxa de mudança "padrão" para planejar as APIs, você pode esperar que as mudanças sejam necessárias a cada novo lançamento de software. Isso pode significar que alterações estão sendo feitas (e precisam ser testadas e validadas) a cada poucas semanas, todos os meses ou mesmo todos os dias, dependendo da cadência de lançamento. Também pode haver alterações ad hoc conforme necessário.

O que é crucial para as equipes garantirem é que essas alterações não interrompam a funcionalidade ou o desempenho de uma API. Para tornar isso possível, as equipes estão aproveitando cada vez mais os testes de contrato de API para fornecer uma espécie de rede de segurança. Isso ocorre na forma de teste que valida as alterações em relação a um "contrato" que detalha a funcionalidade original, acordada e, portanto, necessária de uma API.

A capacidade de prever os impactos das mudanças nas APIs pode depender da maturidade de uma equipe de engenharia e sua capacidade de colaborar entre departamentos, fusos horários e níveis variados de conhecimento técnico. As ferramentas e diretrizes que promovem a padronização e a colaboração podem evitar que contratempos ignorem ou fiquem cegos aos efeitos negativos a jusante.

Quer estejamos falando sobre ser capaz de confiar em uma única fonte de verdade para a versão mais atualizada de uma API publicada ou a edição mais recente do manual de um misturador para receitas de bebidas testadas e comprovadas, uma documentação clara e concisa é chave. Mas também não basta que essa documentação simplesmente exista.