API-Vertrag

Eine formale Spezifikation einer API (OpenAPI, gRPC-Proto, GraphQL-Schema), zu deren Einhaltung sich Anbieter und Konsumenten verpflichten.

Was ist API-Vertrag?

Ein API-Vertrag verwandelt eine Schnittstelle von informellem Stammeswissen in ein versioniertes Artefakt. Er ermöglicht client-generierten Code, Kompatibilitätsprüfungen in der CI und Consumer-Driven-Contract-Tests. Für die teamübergreifende Koordination ist er eines der wirkungsvollsten Dokumentationselemente, die eine Architektur besitzen kann.

Verwandte Begriffe

  • Event-Kanal — Ein benannter, typisierter Strom von Ereignissen (oft ein Kafka-Topic oder Äquivalent), über den Dienste asynchron publizieren und abonnieren.
  • Microservices — Ein Architekturstil, der eine Anwendung als Sammlung kleiner, unabhängig auslieferbarer Dienste strukturiert, die um Geschäftsfähigkeiten herum organisiert sind.

Mehr erfahren