Zum Inhalt springen

Vertrag Erstes Design

Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.

  • Besseres Verständnis der Grundsätze der Vertragsgestaltung
  1. Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.
  2. Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.
  3. Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen.