Eine Fibel zur API-First Strategie

Übersicht

Die heutige Softwarelandschaft ist nicht mehr auf Web und Mobile beschränkt. Die aktuelle Generation von Produkten muss so konzipiert sein, dass sie auf zahlreichen Geräten mit unterschiedlichen Datenformaten und Formfaktoren funktioniert. Noch wichtiger ist, dass sich dies in einem rasanten Tempo entwickelt und nicht im Voraus festgelegt werden kann. Das Ziel jeder Anwendung oder jedes Produkts sollte die Teilnahme an einem Ökosystem von Diensten sein und nicht eine eigenständige monolithische Anwendung. Die Herausforderung besteht darin, welches Design, welche Prozesse und Praktiken dazu beitragen können, ein erfolgreiches Produkt in einer solchen Umgebung zu entwickeln. Dieser Blog gibt einen Überblick über einen grundlegend neuen Weg, mit einem solchen Szenario umzugehen: eine API-First Strategie

Was ist eine API-First-Strategie?

Traditionell verfolgen Unternehmen bei der Entwicklung von Softwareprodukten und -anwendungen eine Code-first-Strategie. Sie begannen mit der Entwicklung einer Website, dann einer mobilen App und brachten sie auf den Markt. APIs waren bestenfalls ein nachträglicher Gedanke, der nur dann entwickelt wird, wenn eine Integration von Drittanbietern erforderlich ist (häufig aufgrund von Geschäfts- und Marktanforderungen). Bei einem Code-first-Ansatz behandelten die Unternehmen die API-Entwicklung als einen separaten Kanal, was zu einer künstlichen API führte, die nicht gut konzipiert, durchdacht, genutzt oder optimiert war. Außerdem führte dies zu einer Vielzahl von Fehlern, Sicherheitslücken und längeren Entwicklungszyklen. Ein besserer Ansatz ist die Entwicklung der Anwendungsprogrammierschnittstelle (API) zu erstellen und dann die Website und die mobilen Anwendungen als Clients zu entwickeln, die diese APIs nutzen.

Eine API-First-Strategie bedeutet, dass zunächst eine API entwickelt wird, die die Geschäftsregeln, den Prozess und den Wert eines Produkts kapselt, und darauf dann das Produkterlebnis (für den Benutzer) aufgebaut wird.

Warum API-First?

Früher haben nur Menschen Daten konsumiert. Jetzt konsumieren sowohl Menschen als auch Maschinen Daten, was zur Erzeugung von Petabytes an Daten führt. In der modernen Welt der Anwendungen findet die Kommunikation von Mensch zu Maschine, von Maschine zu Mensch und von Maschine zu Maschine in einem sich ständig erweiternden interaktiven Modus statt. So bilden z.B. Ihre Smartwatch, Ihr Smartphone und Sie selbst ein geschlossenes System, in dem ständig Daten und Funktionen konsumiert und erstellt werden. Auch Geräte wie Google Home, Alexa usw. haben menschenähnliche Persönlichkeiten und Interaktionsmöglichkeiten entwickelt.

Daher muss jedes Unternehmen, das Produkte entwickeln will, diese so gestalten, dass sie auf jedem Gerät zugänglich sind und genutzt werden können. Sie sollten gut aussehen und funktionieren und gleichzeitig ein nahtloses Erlebnis bieten. APIs ermöglichen es Unternehmen, Funktionen in einzelne, autonome Dienste aufzuteilen, und eine API-first-Strategie erlaubt es, Produktfunktionen zu entwickeln, die über mehrere Geräte und Kanäle genutzt werden können.

Vorteile der API-First-Entwicklung

Ein API-first-Ansatz für die Produktentwicklung bietet zahlreiche Vorteile, von denen einige im Folgenden aufgeführt sind:

Asynchrone Entwicklung

Die API-First-Entwicklung ermöglicht die Entwicklung von Produktfunktionen unabhängig von UI/UX. Spezialisierte Teams können UI/UX z.B. für eine Website, eine mobile App usw. unter Verwendung von "gespiegelten" API-Antworten entwickeln, wodurch sichergestellt wird, dass die Entwicklung parallel und in einem asynchronen Modus erfolgt. Außerdem können Sie auf diese Weise flexibel auf alle Änderungen reagieren.

Reduzierte Entwicklungskosten

Neue Geräte und/oder Vertriebskanäle erfordern oft eine Untermenge oder eine Erweiterung bereits vorhandener Funktionen. Durch die Entwicklung einer API-first-Lösung wird es einfach, nur ein bestimmtes Gerät oder einen bestimmten Kanal über ein API-Gateway und eine Verwaltungsschicht über der API zu bedienen.

Verkürzte Markteinführungszeit

Auf dem heutigen Markt müssen neue Produkte und Funktionen immer schneller auf den Markt gebracht werden. Das schließt lange Entwicklungszeiten aus. Wenn der größte Teil der Funktionalität vorhanden ist und nur ein Delta benötigt wird, kann dies leicht über eine API erfolgen, anstatt den Code eng an eine bestimmte Benutzeroberfläche, ein Gerät oder einen Kanal zu koppeln.

Geringeres Risiko eines Ausfalls

Die API-First-Strategie ermöglicht eine einzige Quelle der Wahrheit in Bezug auf Merkmale und Funktionalität, während viele Formfaktoren und UI/UX darauf aufgebaut werden können. Dies ermöglicht es, eine API gründlich zu testen und auf Zuverlässigkeit, Fehler und Konsistenz zu prüfen. Selbst wenn wir also eine Vielzahl von Geräten, Kanälen und Formfaktoren haben, kann ein Fehler leicht behoben werden, und sein Wert spiegelt sich in allen Kanälen auf einen Schlag wider.

Aktivieren Sie Metriken, Messwerte und Drosselung

Das Hinzufügen eines API-Gateways auf der API ermöglicht eine kanalspezifische Drosselung, Metrik und Messung von API-Aufrufen in Bezug auf Geräte, Volumen und Qualität. Dies wird dann zur ersten Verteidigungslinie, unabhängig von der Anwendungsfunktionalität, und kann asynchron von einem separaten Team gehandhabt werden.

Wie plant man eine API-First-Implementierung?

Bevor eine API erstellt wird, müssen wir die folgenden wichtigen Aspekte im Auge behalten:

Identifizieren Sie

Wir müssen auf breiter Ebene festlegen, wie die wichtigsten Dienste eines Endprodukts aufgeteilt werden sollen. Jede übergeordnete Sammlung von Endpunkten sollte als Teil einer Geschäftsfunktion gebündelt werden. Zum Beispiel für ein E-Commerce-Produkt: alle artikelbezogenen Endpunkte wie "get item description", "get price" usw. Für jede Sammlung auf hoher Ebene sollte es einen oder mehrere Beteiligte und einen oder mehrere Eigentümer geben, die das Design der API überprüfen und auch darüber informieren können, wie die Interaktionen aus Sicht der Funktionen ablaufen müssen. Diese wiederum helfen bei der Definition der Granularität der API-Endpunkte.

Definieren Sie API-Endpunkte

Sobald die Trennung der API auf hoher Ebene definiert ist, müssen wir jedes Anliegen auf hoher Ebene in granulare Endpunkte aufteilen, die eine maximale Wiederverwendbarkeit ermöglichen und gleichzeitig sicherstellen, dass die Anzahl der Endpunkte nicht über ein vernünftiges Maß hinausgeht. Dies wirkt sich direkt auf die Latenzzeit und die Geschwindigkeit der Antworten des Dienstes aus. Wenn eine Funktion durch einen einzigen Aufruf der API ausgeführt werden kann, sollte sie mehreren Aufrufen der API vorgezogen werden. Dies ist häufig ein Kompromiss, und ein optimales Gleichgewicht kann durch Gespräche mit den Produktbeteiligten und dem UI/UX-Team gefunden werden.

API-Definition dokumentieren

Dokumentieren Sie alle API-Endpunkte. Vorzugsweise sollte sie automatisch generiert werden. Swagger ist z.B. ein großartiges Tool, das dabei hilft, API-Definitionen mit dem Code synchron zu halten. Wie man so schön sagt: "Der Code ist die Wahrheit" !!!!. Das API-Definitionsdokument hilft den potenziellen Nutzern der API dabei, zu erkennen, wie eine Anfrage strukturiert sein muss und welche Antworten sie erhalten können. So können sie ihre Anwendung ohne Reibungsverluste entwickeln.

API Style Guide

Ein umfassender, kohärenter und konsistenter Styleguide stellt sicher, dass die Entwicklungsteams im gesamten Unternehmen dieselben API-Statuscodes, Versionierungen, Fehlerbehandlungen, erforderlichen (und optionalen) Header usw. verwenden.

Automatisierte Tests

Jede API, die erstellt wird, muss durch eine automatisierte Suite von Unit-, Regressions- und Integrationstests qualitätsgesichert werden. Dadurch wird sichergestellt, dass nicht versehentlich frühere Funktionen zerstört oder neue Fehler eingeführt werden und dass der Zweck der Funktionen von Build zu Build erhalten bleibt. Dies gilt insbesondere dann, wenn es viele Kunden für die API gibt, die ihre eigenen speziellen Anforderungen haben. Eine automatisierte Testsuite, die als Teil Ihrer Continuous Development/Continuous Integration (CD/CI) Pipeline läuft, ist ein Muss.

Versionierung

Es sollten Richtlinien zur API-Versionierung und Abwärtskompatibilität festgelegt werden. API-Änderungen sind unvermeidlich, und es ist keine gute Idee, die Art und Weise, wie wir damit umgehen wollen, auf einen späteren Zeitpunkt zu verschieben. Die Hölle der API-Versionierung ist eine reale Sache, wenn sie nicht bis zur Version 1.0 der API durchdacht ist.

Entwickler-Portal

Erstellen Sie ein zentrales, internes Repository für Entwickler, einen Ort, an dem alle Ihre API-bezogenen Ressourcen gespeichert werden - API-Spezifikation, Dokumentation, Verträge usw. Confluence von Atlassian ist z.B. ein großartiges Tool für die Verteilung von Dokumentation und Informationen.

API-erste Architektur

Oben sehen Sie eine beispielhafte Architektur eines Produkts, das mit einem API-first-Ansatz erstellt wurde.

Fazit

Die API-First-Strategie ist ein hervorragender Weg, um Produkte auf agile und effiziente Weise zu entwickeln und ermöglicht es Unternehmen, zukunftssichere Anwendungen zu erstellen, die wirklich geräte- und systemunabhängig sind.