Das Wissensportal für IT-Professionals. Entdecke die Tiefe und Breite unseres IT-Contents in exklusiven Themenchannels und Magazinmarken.

SIGS DATACOM GmbH

Lindlaustraße 2c, 53842 Troisdorf

Tel: +49 (0)2241/2341-100

kundenservice@sigs-datacom.de

Design von APIs ist Arbeit, Arbeit und nochmals Arbeit

Herzlich willkommen zu einer Situation aus dem Alltag eines Entwicklungsteams. Es ist Mittwoch und das Planning für den kommenden Sprint ist im vollen Gange. Das Team soll Abschätzungen in Bezug auf eine neu zu schaffende API für die ERP-Lösung anstellen. Für alle Mitglieder des Teams scheint die Lösung auf Basis einer Rest(ful)-API klar und wird mit einem geringen Zeitaufwand geschätzt. Während des Sprints wird nach einer ersten Feedbackschleife mit dem Konsumenten deutlich, dass der Use-Case der Schnittstelle doch nicht so klar und eindeutig ist. Ebenso wurden auch die Belange von Security bei der Schätzung erst mal außen vorgelassen. Sodass am Ende des Sprints keine API bereitgestellt werden konnte. Warum konnte es zu einer solchen Fehlinterpretation und -abschätzung kommen?

Genau diese Frage lässt sich nicht so einfach beantworten. Denn die Erstellung einer API mit einer guten Experience ist gar nicht so einfach. Aber was genau ist nicht einfach? In der Regel werden APIs für einen bestimmten Zweck beziehungsweise bekannten Konsumenten erstellt. Meist auch noch nach dem „Code first”-Ansatz, das heißt, die API entsteht direkt beim Schreiben des Codes und im Anschluss wird dann eine Beschreibung erstellt. Bei der Verwendung von Code first haben die Konsumenten keine …