O que é uma abordagem API primeiro?
A abordagem API-first contrasta fortemente com a abordagem code-first, na qual uma equipe começa projetando a funcionalidade do aplicativo, escrevendo o código e, em seguida, adicionando API no final do processo.
Na Zonos, desenvolver software com uma abordagem API primeiro significa projetar soluções em torno de uma API, em vez de codificar uma aplicação e adicionar uma API posteriormente. Isso significa que nossos API são fundamentais e são produtos em si; Nós os projetamos com foco intenso nas necessidades do cliente e os documentamos e arquitetamos claramente antes de escrever qualquer código.
Os benefícios de uma abordagem API primeiro
A abordagem API primeiro ajuda a estabelecer a seguinte mentalidade:
- Entendemos que nossos APIs são a interface principal para nossos clientes e, portanto, os consideramos nossos produtos públicos.
- Documentar antes de escrever o código nos dá a oportunidade de raciocinar, debater, refinar e comunicar nossos objetivos às nossas equipes e partes interessadas para criar um produto final melhor.
- Ao nos concentrarmos nas necessidades de nossos clientes, entendemos a melhor forma de projetar APIs que atendam a essas necessidades.
Esta mentalidade coloca a API e os clientes em primeiro lugar e é fundamental para estabelecer uma base onde todos na Zonos sejam responsáveis pelo sucesso do cliente.
As equipes de desenvolvimento podem trabalhar em paralelo
A primeira abordagem do API envolve o estabelecimento de um contrato. A criação de um contrato de serviços cruzados que é seguido pelas equipes de uma organização permite que essas equipes trabalhem em vários APIs ao mesmo tempo. Os desenvolvedores não precisam esperar o lançamento das atualizações do API antes de passar para o próximo API. As equipes podem simular e testar dependências API e API simultaneamente com base em definições API pré-estabelecidas.
Reduza o custo de desenvolvimento
O API e o código podem ser reutilizados em diversos projetos diferentes. Na abordagem API-first, se uma equipe de desenvolvimento quiser criar um novo aplicativo, não será necessário começar do zero, o que economiza tempo e dinheiro. O design do API-first também permite que a maioria dos problemas sejam resolvidos antes de escrever qualquer código, ajudando a prevenir problemas quando chega a hora de integrar o API aos aplicativos.
Aumente a velocidade de lançamento no mercado
Grande parte do processo de criação do API pode ser automatizado usando ferramentas para importar arquivos de definição do API. Começamos gerando os principais tipos, definições e esquemas; Com esses arquivos, ferramentas API como documentação API, kits de desenvolvimento de software (SDK) e API simulado podem ser gerados automaticamente. A automação acelera significativamente o desenvolvimento do API e de aplicativos.
O API-first também possibilita adicionar novos serviços e tecnologias às aplicações sem a necessidade de reestruturar todo o sistema. A Zonos deve enviar recursos para produção rapidamente para permanecer competitiva no mercado SaaS internacional em constante mudança. É mais fácil eliminar dívidas técnicas no código subjacente do que migrar clientes de um API mal projetado.
Garanta boas experiências para desenvolvedores
Os consumidores do API são normalmente desenvolvedores, e a experiência do desenvolvedor (DX) pode determinar o sucesso ou o fracasso de um API. A abordagem API primeiro garante que a experiência do desenvolvedor seja positiva porque um API bem projetado, bem documentado e consistente é mais fácil de aprender e reutilizar. Isso também aumenta a velocidade de implantação. Todos esses benefícios estão interligados!
Aumentar o sucesso a longo prazo
Uma abordagem API permite prototipagem e iteração rápidas, o que significa que aprendemos mais rapidamente o que funciona e o que não funciona. Tal como as 1.000 tentativas falhadas de Edison antes de criar a lâmpada, API-first significa que falhamos rapidamente e avançamos com uma melhor compreensão de como ter sucesso. API-first aumenta nosso sucesso a longo prazo, garantindo que os APIs sejam confiáveis, consistentes e fáceis de desenvolver.
Por que trabalhar de trás para frente é eficaz?
Em 2015, tive a oportunidade de redesenhar o site de comércio eletrônico de uma marca popular de consumo. Avaliei vários indicadores-chave de desempenho (KPIs) relacionados ao sistema existente e ficou claro onde as maiores melhorias poderiam ser alcançadas:
- A taxa de conversão no desktop era baixa.
- A taxa de conversão móvel foi péssima.
- A percentagem de tráfego móvel estava a aumentar rapidamente e ultrapassaria 50% do tráfego total nos próximos 12 meses. Devido à péssima taxa de conversão móvel, ter a maior parte do tráfego móvel não era o ideal.
Dados os dados, o que criaria mais valor para os usuários? Foi óbvio: corrigir os problemas com a experiência do usuário móvel do site. Portanto, adotei uma abordagem que prioriza os dispositivos móveis para redesenhar o site. Isso significava que todos os designs, arquitetura, APIs, etc. consideravam a experiência móvel em primeiro lugar. Isso era o oposto da abordagem tradicional da época, que se concentrava primeiro na experiência do desktop, muitas vezes deixando a experiência móvel como um complemento desajeitado com baixas taxas de conversão. A abordagem mobile-first também exigiu mais esforço inicial: não foi o caminho mais fácil. Uma nova arquitetura era necessária, novos APIs teriam que ser escritos e vários projetos eram necessários para cada ponto de interrupção.
A abordagem mobile-first resultou em um aumento significativo na taxa de conversão mobile. A nova arquitetura também produziu melhorias impressionantes na taxa de conversão de desktops. A abordagem foi bem-sucedida porque identificou como criar valor máximo para o usuário e concentrou todo o foco em fornecer esse valor. Ele criou a mentalidade certa desde o início. Da mesma forma, embora possa parecer um retrocesso, uma abordagem API primeiro cria oportunidades para identificar problemas amplos e, em seguida, construir uma base para corrigi-los.
Qual é a responsabilidade da engenharia?
A mentalidade do API liderou e continuará a liderar o Zonos ao sucesso, e a engenharia desempenha um papel fundamental. É nossa responsabilidade manter sempre a mentalidade API primeiro. Isso significa que fazemos constantemente perguntas que mantêm o foco em nossos APIs, como: “Como podemos API atender às necessidades do cliente?” Isso também significa que sempre respondemos perguntas sobre recursos e funcionalidades com um link para nossa documentação API. Caso a documentação não exista, nós a criamos, trabalhando em conjunto em equipas multifuncionais para garantir que a Zonos possui uma excelente documentação da API.
Como uma abordagem API está moldando o futuro da Zonos
Você já se perguntou o que significa ser a primeira empresa API? Leia a perspectiva de Andrew Spencer, vice-presidente de engenharia da Zonos, sobre como uma abordagem API first está moldando o futuro da Zonos.
Zonos é a primeira empresa API. Há muita informação condensada nessa breve declaração. Então, o que isso realmente significa? Este blog irá detalhar o conceito de uma empresa API pioneira, conforme demonstrado pela Zonos.
Se afirmarmos que a Zonos é uma empresa que prioriza a API, segue-se que as nossas API são a principal estratégia através da qual alcançamos a nossa missão de construir confiança no comércio global. Taticamente, isso significa que devemos adotar uma abordagem API que prioriza toda a empresa em tudo o que fazemos. Ao considerar as necessidades de um cliente, a primeira coisa que perguntamos é: "Como podem os nossos API satisfazer as necessidades do cliente?"
Para entender melhor o que significa ser uma empresa API pioneira, este blog abordará o seguinte: