Der Einsatz von API Management ermöglicht es Ihnen, neue Bedürfnisse Ihrer Kunden schnell und wirkungsvoll zu erfüllen. Doch wie können Sie die Geschwindigkeit bei der Umsetzung nachhaltig steigern, ohne dass dabei die Softwarequalität und der erzielte Kundennutzen leidet?

Die Antwort lautet: API Design First!

 

API Design: Ein Einblick

Im folgendem Abschnitt zeigen wir Ihnen auf, welche Phasen das API innerhalb des API Design Prozesses durchläuft. Zudem erfahren Sie, mit welchen Massnahmen Sie die Umsetzungsgeschwindigkeit steigern können.

API Management

Abbildung 1: Einblick in den API Design Prozess

 

Service-Idee gemeinsam schärfen und Zielbild erstellen

In einem ersten Schritt geht es darum, die freigegebene Service-Idee zu verstehen und zu verfeinern. Es muss klar sein, welche Daten oder Funktionen (Assets) Sie mittels API bereitstellen müssen. Daher empfiehlt es sich für diese Aufgabe, zusammen mit den Stakeholdern ein gemeinsames Verständnis zu schaffen. Zudem sollten Sie die genauen Ausprägungen der Assets festlegen. Sobald dies getan ist, können Sie das bestehende API Repository prüfen und im besten Fall sogar ein bestehendes API wiederverwenden. Falls Sie eine API nur punktuell erweitern müssen, können Sie dies durch einen Change Request übergeben und anschliessend geprüft und eingeplant werden lassen.

Gemeinsam mit den Stakeholdern entsteht dann ein Zielbild, mit welchen bestehenden, zu erweiternden oder neuen API Sie die neue Service-Idee umsetzen können. Zugleich stellen Sie dadurch die Wiederverwendung bereits bestehender Microservices oder API sicher. Auf diese Weise verhindern Sie den Bau und die Wartung von neuen, gleichartigen Microservices oder API.

API Management

Abbildung 2: Zielbild Umsetzung Service-Idee

 

API Design gemeinsam erstellen und Mockups zur Verfügung stellen

Ist ein neuer Microservice oder auch API notwendig, so können Sie unter Berücksichtigung der bestehenden Integrations-Vorgaben mit deren Design starten. Um gleich zu Beginn die Qualität des Designs zu steigern, lohnt es sich, gemeinsam mit den Applikations-Managern der identifizierten und anzubindenden Systeme das Design inklusive Spezifikation und Modell des jeweiligen API zu erarbeiten. Dadurch können Sie Unklarheiten, welche sonst zu einem späteren Zeitpunkt des Entwicklungsprozesses aufgetreten wären, bereits in dieser frühen Phase beseitigen. Das Design beinhaltet mindestens die Festlegung der angebotenen Methoden, des Daten-Umfangs, -Formats, und -Menge, der Protokolle, der Fehlerbehandlung der Statuscodes und der Beispieldaten.

Mit den dadurch gewonnenen Informationen können Sie das API zum Beispiel mit der Modellierungs-Sprache RAML modellieren, dokumentieren und gleich als Mock-up zur Verfügung stellen. Die Umsysteme können nun gegen die publizierten Spezifikationen und Mockups entwickeln. Dabei werden Anfragen automatisch beantwortet, noch bevor für die API eine einzige Zeile Code geschrieben wurde!

 

Service-Idee verifizieren und für die parallele Entwicklung freigeben

Die Applikations-Manager und auch Entwickler der Umsysteme werden dadurch befähigt, ihre Aufwände noch genauer abschätzen zu können. Sobald die gesamten Aufwände für die Umsetzung zusammengetragen wurden (siehe Schätzpunkte 1-7 im Zielbild), kann die Service-Idee verifiziert werden. Danach werden sie für die Prüfung durch die Stakeholder publiziert.

Bei Freigabe der verifizierten Service-Idee durch sämtliche Stakeholder können Sie mit der parallelen Entwicklung starten. Während Sie das Frontend- und Backend-System gegenüber den Mock-ups der API entwickeln und testen, können die API und der neue Service basierend auf dem Design entwickelt und getestet werden.

 

Unser Fazit

Das frühe Erstellen und Zurverfügungstellen des API Designs – insbesondere der Mockups – ermöglicht es, Unklarheiten schon vor der Entwicklung zu klären. Dies wiederum ermöglicht eine effiziente Entwicklung. Nutzen Sie diese Möglichkeit! Wir sind Experten im Bereich API Management und freuen uns, Sie dabei zu unterstützen.

Möchten Sie mehr zum Thema API Management lesen? Dann besuchen Sie gerne unsere Blog-Seite dazu oder folgen Sie uns auf LinkedIn, um keine Beiträge zu verpassen.

Jean-Marc Riser

Jean-Marc Riser

Senior Technical Consultant

 jean-marc.riser@valion.ch

André Bally

André Bally

Senior Partner

 andre.bally@valion.ch

Share This