Contrato de API

Una especificación formal de una API (OpenAPI, proto de gRPC, esquema de GraphQL) que productores y consumidores se comprometen a respetar.

¿Qué es Contrato de API?

Un contrato de API convierte una interfaz de conocimiento tribal en un artefacto versionado. Permite generar código de cliente, comprobaciones de compatibilidad en CI y pruebas de contrato impulsadas por el consumidor. Para la coordinación entre equipos es una de las piezas de documentación de mayor impacto que una arquitectura puede poseer.

Términos relacionados

  • Canal de eventos — Un flujo de eventos nombrado y tipado (a menudo un topic de Kafka o equivalente) a través del cual los servicios publican y se suscriben de forma asíncrona.
  • Microservicios — Un estilo de arquitectura que estructura una aplicación como un conjunto de servicios pequeños, desplegables de forma independiente y organizados en torno a capacidades de negocio.

Más información