Guia para Design de APIs
API First ou Design First
É uma abordagem de construção de APIs em primeiro lugar, ou seja, elas são pensadas antes mesmo de se escrever o código. Deste modo, tudo no projeto gira em torno da ideia de que o produto final, no caso as APIs, serão consumidas para aplicativos clientes como aplicações mobile e web, por exemplo.
Desenvolver APIs, antes de tudo, envolve a construção de produtos consistentes e reutilizáveis, com design dos contratos bem definidos para o comportamento que se espera. Estabelecer um contrato envolve gastar mais tempo pensando no design e também envolve planejamento e colaboração de outras partes interessadas, fornecendo feedback antes que qualquer código seja feito. 1
Alguns benefícios
- Evita problemas de integração
- Aumenta a velocidade de entrega para o mercado
- Garante boas experiências aos consumidores das APIs
- Reduz o risco de falhas
Code First
Primeiro código, é uma abordagem mais tradicional e com ela propõe-se desenvolver o código logo após a definição dos requisitos de negócio. Essa abordagem ainda é utilizada hoje em dia, principalmente para projetos internos em que é necessário desenvolver rapidamente os requisitos de negócio e somente depois é gerada uma documentação. 2
Referências: