Glossar   /   API-Entwicklung

API-First

Bei API-First wird die Schnittstelle früh gemeinsam geplant, bevor ihre technische Umsetzung die Zusammenarbeit festlegt.

Auch bekannt als: API-zentrierte Entwicklung

Was bedeutet API-First?

Die beteiligten Teams besprechen zuerst, welche Daten und Funktionen andere Anwendungen benötigen. Sie vereinbaren Anfragen, Antworten und Fehlerfälle. Mit einer einfachen Nachbildung der Schnittstelle können die Nutzer bereits beginnen, während der eigentliche Dienst entsteht.

Das Vorgehen braucht gemeinsame Entscheidungen und laufende Pflege. Eine einmal geschriebene Beschreibung genügt nicht, wenn Umsetzung und Vereinbarung später auseinanderlaufen.

So sieht das in der Praxis aus

Beispiel: Die Teams für Warenwirtschaft und App vereinbaren zuerst die Auftragsdaten und entwickeln dann ihre jeweiligen Programmteile.

Häufige Fragen

Wann hilft API-First besonders?

Wenn mehrere Teams oder Anwendungen dieselbe Schnittstelle benötigen. Eine früh abgestimmte Vereinbarung ermöglicht parallele Arbeit und macht unterschiedliche Erwartungen sichtbar.

Wie unterscheidet sich API-First von Contract-First?

API-First beschreibt die gemeinsame Ausrichtung der Entwicklung auf Schnittstellen. Contract-First bezeichnet genauer das Vorgehen, zuerst eine ausdrückliche technische Vertragsbeschreibung zu erstellen.

Kann die Oberfläche trotzdem zuerst als Entwurf entstehen?

Ja. Ein Oberflächenentwurf kann zeigen, welche Daten gebraucht werden. Entscheidend ist, den Schnittstellenvertrag vor der verbindlichen Umsetzung gemeinsam abzustimmen.

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: Guide to API-first
← 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