Contrato de API

Uma especificação formal de uma API (OpenAPI, proto gRPC, schema GraphQL) que produtores e consumidores concordam em respeitar.

O que é Contrato de API?

Um contrato de API transforma uma interface de conhecimento tribal em um artefato versionado. Ele viabiliza código gerado para o cliente, verificações de compatibilidade na CI e testes de contrato orientados pelo consumidor. Para a coordenação entre equipes, é uma das peças de documentação de maior alavancagem que uma arquitetura pode ter.

Termos relacionados

  • Canal de Eventos — Um fluxo de eventos nomeado e tipado (frequentemente um tópico Kafka ou equivalente) por meio do qual os serviços publicam e assinam de forma assíncrona.
  • Microsserviços — Um estilo de arquitetura que estrutura uma aplicação como uma coleção de serviços pequenos, implantáveis de forma independente e organizados em torno de capacidades de negócio.

Saiba mais