API Lifecycle Management – As diversas fases do ciclo de vida de uma API

A abordagem do API lifecycle management fornece uma visão holística sobre como gerenciar os diferentes estágios de desenvolvimento de uma API, ao longo de todo o ciclo de vida.

Conforme mostrado na Figura 1 abaixo, a API tem um ciclo de vida duplo. O ciclo da esquerda abrange as atividades do produtor, enquanto o da direita envolve as atividades do consumidor.

As fases de Gerenciamento

1. Fase de Estratégia

Nesta fase, você terá que definir as metas que deseja alcançar com suas APIs. Ela também especifica quais mercados que você precisa abordar, quais recursos você tem à sua disposição, o prazo que você tem para atingir os seus objetivos, e assim por diante. Essa é uma etapa crucial, que poderá ajudá-lo a concentrar os seus esforços onde é mais importante.

2. Fase de Design

Esta fase garante que a sua organização usará uma abordagem de primeiro contrato. Esse procedimento envolve a coleta de feedback antecipado, quebrando as dependências entre os projetos e reduzindo os riscos. Além disso, uma abordagem de primeiro contrato é conhecida por reduzir o tempo de lançamento no mercado.

Na fase de design, você projeta o contrato de sua API e o compartilha com os seus futuros consumidores. O resultado é um contrato de API que descreve as mensagens que podem ser trocadas com as suas APIs.

3. Fase de Simulação

Na simulação, você deverá criar exemplos significativos da carga útil de suas APIs e tentar alinhar as suas especificações com as expectativas de negócios. Esses exemplos são depois transformados em uma simulação ao vivo que pode ser exposta aos seus primeiros consumidores.

As expectativas de negócios dizem respeito a tudo o que não pode ser especificado usando um esquema formal. Por exemplo, ao consultar itens por status, todos os itens devolvidos devem ter o status desejado.

4. Fase de Teste

Na fase de testes de aceitação, você terá que definir os seus casos de teste, com base em exemplos, antes de implementar as suas APIs. Isso ajudará a refinar as suas expectativas de negócios, compartilhá-las entre os desenvolvedores, testadores e clientes e depois certificar-se de que as suas APIs atendem às expectativas.

5. Fase de Implementação

Na Implementação, a API real é desenvolvida usando uma estrutura de integração. Uma estrutura de integração é uma parte fundamental do ciclo de vida de suas APIs para promover a reutilização, iterações rápidas e acréscimos de valor por meio da orquestração. Ela também ajuda a modernizar as partes existentes do seu sistema de informação. As práticas atuais de desenvolvimento ágil também se aplicam aqui.

6. Fase de Implantação

Na Implantação, você deve se certificar de ter um pipeline de integração contínua / implantação contínua (CI/CD) que automatize a entrega de suas APIs ao ambiente de produção. O pipeline CI/CD reutiliza os testes que você definiu anteriormente para garantir que as APIs a serem implantadas não violem as suas especificações.

7. Fase de Segurança

A segurança é uma etapa importante no ciclo de vida da API. O teste de segurança automatizado, como análise estática ou teste de vulnerabilidade, deve fazer parte do seu pipeline. Práticas de desenvolvimento seguro, como revisões de código, também devem fazer parte de seu ciclo de vida de desenvolvimento.

8. Fase de Gerenciamento

A esta altura, as APIs precisam ser gerenciadas. O gerenciamento abrange o controle de versão, a descontinuação e a retirada. Como prática recomendada, o controle de versão deve seguir o esquema de controle de versão semântico. Isso significa que qualquer nova versão secundária de uma API substitui a versão anterior. Todos os consumidores que usavam a versão anterior poderã