Pular para o conteúdo
APIOps Cycles
APIOps meetups are back! Join us for the next one, more info at apiops.info.

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

Seção intitulada “Resultados”
  • Melhor compreensão dos princípios de conceção da primeira fase do contrato

Como funciona

Seção intitulada “Como funciona”

Passos

Seção intitulada “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.