O documento discute SOA vs microserviços, contratos de API e desafios de versionamento de contratos de API. Ele explica que SOA usa um ESB para integrar serviços, enquanto microserviços permitem equipes independentes usando diferentes tecnologias. Contratos de API documentam endpoints, parâmetros, respostas e exemplos. Mudanças que não quebram a compatibilidade preservam consumidores, enquanto mudanças incompatíveis requerem nova versão. Desafios incluem manter compatibilidade, documentação atualizada e forçar mig

1. SOA x Microservices
Apresentação 2
Daniel Christofolli
e
Versionamento
de Contrato

2. SOA
SOA é uma filosofia usada para fazer a integração de serviços que
seguem um mesmo padrão através de um Enterprise Service Bus
(ESB).

3. Microservices
O desenvolvimento é distribuído. Isso significa que as equipes de
desenvolvimento podem ter rotinas diferentes e podem trabalhar
com tecnologias diferentes. Além disso, é possível desenvolver
vários microsserviços ao mesmo tempo.

4. Contrato de API
É a documentação da API, que deve conter:
● Significado, funcionamento e dependências de cada um dos endpoints;
● Métodos HTTP permitidos em cada endpoint e como funcionam;
● Descrição dos campos de input e output, como na figura;
● Descrição do status de cada resposta Qual status é mostrado em cada caso?
● Explicação sobre as requests;

5. Contrato de API
● Exemplo de respostas;

6. Mudanças que não quebram o contrato

7. Mudanças que quebram o contrato

8. Quebra o consumidor

9. Nova versão

10. Versionamento de contrato de API
Desafios
● Compatibilidade – O contrato entre cliente e API é fundamental
e realizar modificações nos endpoints sem quebra de contrato é
a prioridade zero. A compatibilidade deve ser preservada a todo
momento.
● Documentação atualizada – Manter uma documentação
atualizada é vital para o uso de qualquer API. A documentação é
a especificação do produto. Uma má documentação gera mais
chamados para a equipe de suporte e, fatalmente, gera mais
custo para a empresa.

11. Versionamento de contrato de API
Desafios
● Forçar o cliente a migrar;
● Não criar muitas versões;

12. Como versionar?

13. Header
Accept: application/json; version=1.0
Características:
● Menos intrusivo;
● Não polui a URL;
● Fácil de identificar;

14. URL
https://host/api/v1/bands/1/albuns
https://host/api/bands/albuns?version
=1v
Características:
● Explícito;
● Mais clara para os consumidores;
● Mais difícil de ser identificada;