Der Weg zum guten API Design

Heutzutage sind APIs aus der IT-Landschaft nicht mehr wegzudenken. Viele der zeitgemäßen internen und externen Dienste bieten eine solche Schnittstelle zur Benutzung und Integration in eigene Anwendungen an. Hierzu hat sich der RESTful Ansatz etabliert. Ein API zu programmieren ist nicht schwer, ein gutes API zu designen aber umso mehr. Möglicherweise hast Du auch schon das Vergnügen gehabt eine schlechte API anzubinden. Es sind viele Gründe die zu einer schlechten API führen können. Die Endpunkte sind irreführend designed und führen möglicherweise zu falschen Annahmen, HTTP Methoden werden inkonsistent und entgegen der gängigen Definition verwendet, Statuscodes und Rückgabewerte werden wild durcheinandergeworfen, etc. Um an der Stelle nur mal ein paar Beispiele aufzuführen. All diese Punkte können auch ganz schnell zu einem Bumerang werden und zu einem eigenen erhöhten Supportaufwand führen. Deshalb sollte das Ziel immer sein, eine gute API von Anfang an zu designen. Wie so vieles in der Softwareentwicklung ist auch das API Design bis zu einem gewissen Grad Geschmackssache. Daher ist es sehr empfehlenswert im Unternehmen oder dem Projekt eine API-Guideline zu definieren. In unserem Vortrag zeigen wir wie die API Guideline nicht nur dokumentiert, sondern auch automatisiert und nachhaltig im Buildprozess gegen das definierte Regelset überprüft werden kann. Das dabei verwendete Toolset ist vergleichsweise einfach und lässt sich daher in nahezu jedem Projekt einsetzen. Willst auch Du zukünftig gute APIs erstellen? Dann bist Du in dieser Session genau richtig! Wir zeigen Dir in Theorie und Live-Demo ein effektives Tooling, welches Dich beim künftigen guten API Design unterstützt.