Primeira conceção do contrato

Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.

Resultados

• Melhor compreensão dos princípios de conceção da primeira fase do contrato

Como funciona

Passos

1. Aplicar abordagens “contract-first” ou “design-first” para garantir que os contratos API são validados antes da implementação.
2. Definir contratos de API que descrevam as expectativas, responsabilidades e diretrizes de utilização para cada API.
3. Utilizar formatos normalizados (por exemplo, OpenAPI, AsyncAPI) para criar contratos de API legíveis por máquina que sejam fáceis de partilhar e validar.

Dica

• Personalize o design do Contract First para o seu domínio
• Utilize-o de forma colaborativa entre as funções comerciais e tecnológicas