Glossar   /   API-Entwicklung

Contract-First

Bei Contract-First entsteht zuerst eine ausdrückliche Beschreibung der Schnittstelle, nach der die beteiligten Anwendungen entwickelt werden.

Auch bekannt als: Vertragsbasierte Entwicklung

Was bedeutet Contract-First?

Die Teams vereinbaren Funktionen, Datenfelder und Antworten, bevor sie die Schnittstelle umsetzen. Ein maschinenlesbarer Vertrag kann daraus Dokumentation, Testnachbildungen oder Programmgrundgerüste erzeugen lassen.

Das spart keine fachliche Abstimmung ein. Eine formal gültige Beschreibung kann trotzdem wichtige Sonderfälle auslassen. Vereinbarung und tatsächliches Verhalten müssen deshalb gemeinsam überprüft werden.

So sieht das in der Praxis aus

Beispiel: Ein Team beschreibt die Anfragen und Antworten zuerst mit OpenAPI und entwickelt anschließend die passenden Funktionen.

Häufige Fragen

Welche Formate eignen sich für einen Schnittstellenvertrag?

Das hängt von der Technik ab. Für HTTP-Schnittstellen wird häufig OpenAPI verwendet, für andere Verfahren beispielsweise WSDL oder Protocol Buffers.

Kann aus dem Vertrag die gesamte Anwendung erzeugt werden?

Nein. Werkzeuge können Grundgerüste und technische Beschreibungen erstellen. Die eigentliche Geschäftslogik, passende Prüfungen und der Betrieb müssen weiterhin umgesetzt werden.

Wie wird ein Vertrag später geändert?

Änderungen werden mit den betroffenen Nutzern abgestimmt und auf Verträglichkeit geprüft. Beschreibung, Implementierung und Tests sollten denselben vereinbarten Stand abbilden.

Das könnte Sie auch interessieren

Passend zum Thema

API-Entwicklung Agentur Verbindliche Austauschbedingungen für angebundene Anwendungen erarbeiten.

Quellen und weiterführende Informationen

Postman: Design API Specifications
← Zurück zu allen Glossarbegriffen

Austauschregeln gemeinsam festlegen

Mehrere Anwendungen sollen verlässlich zusammenarbeiten? Stimmen Sie benötigte Angaben, Antworten und das Verhalten bei Abweichungen frühzeitig ab.

Kontakt aufnehmen