Erste API-Implementierung

APIs bilden das Nervenzentrum von Softwareanwendungen. Es ist also wichtig, dass die Anbieter sich darüber im Klaren sind, was sie anbieten können, und dass die Verbraucher sich darüber im Klaren sind, was sie konsumieren wollen. Ein besseres Verständnis der APIs garantiert ein hervorragendes Ergebnis. Bei API First geht es um die Schaffung einer gemeinsamen Vereinbarung zwischen Anbietern und Verbrauchern. Dieser Entwurf trägt dazu bei, dass beide Parteien auf derselben Seite stehen.

Wenn Sie den API-First-Ansatz übernehmen, können Sie als API-Entwickler die API-Entwicklung mit dem API-Vertrag beginnen. An der Umsetzung können Sie zu einem späteren Zeitpunkt arbeiten. Dieser Ansatz, dem API-Design Vorrang vor der Implementierung zu geben, ist sowohl für Anbieter als auch für Verbraucher von Vorteil.

In herkömmlichen Szenarien stellen Anbieter ihren Kunden APIs erst dann zur Verfügung, wenn die API implementiert ist. Die Verbraucher testen die API und geben den Anbietern ihr Feedback zur API. Die Anbieter müssen dann die API überarbeiten, um die Rückmeldungen ihrer Kunden zu berücksichtigen. Sie können diesen Prozess optimieren, indem Sie das API-First-Design anpassen.

Mit dem API-First-Ansatz müssen die Verbraucher nicht darauf warten, dass der Anbieter die API implementiert, sondern können mit der Entwicklung ihrer Anwendung fortfahren, indem sie die offengelegte API verwenden. Der Implementierungsstatus der API hat keine Auswirkungen auf die Verbraucher, da sie die vorgesehenen Antworten auf ihre Anfragen über die nachgebildete API erhalten. So können die API-Entwicklung und die Anwendungsentwicklung gleichzeitig stattfinden.

Nachdem der Anbieter die API implementiert hat, wird der Endpunkt aktualisiert, um die Aufrufe an die tatsächliche Implementierung statt an die nachgebildete Antwort umzuleiten. Der Anbieter kann dann das Mocking deaktivieren.

Das folgende Diagramm erläutert den Ablauf der API-Entwicklung nach dem API-First-Design.

Nach dem API-First-Konzept legen die Anbieter ihre API für die Verbraucher offen, wenn die Entwicklung im Gange ist.