Читать книгу API-Design - Kai Spichale - Страница 37

Das in diesem Kapitel beschriebene Vorgehen ist in der folgenden Abbildung dargestellt. Grundvoraussetzung für den Entwurf einer API sind deren Anforderungen und deren Rolle im Gesamtsystem. Die Anforderungen werden typischerweise mit Use Cases beschrieben. Wenn diese Informationen vorliegen, können Codebeispiele für die neue API geschrieben werden. Diese Beispiele verwenden repräsentative Szenarien, die die wichtigsten Features abdecken. Sie können die Codebeispiele später auch für Tests einsetzen, doch primär sind sie für den Entwurf gedacht.

Abb. 3–1 Allgemeines Vorgehen beim API-Entwurf mit Feedbackschleifen

Bevor Sie eine API entwerfen können, müssen Sie deren Rolle in der Gesamtarchitektur einordnen. Je nach System kann die API ein ganz entscheidender, wenn nicht sogar der entscheidende Bestandteil der Architektur sein – wenn es beispielsweise darum geht, mit der API die einzelnen Bestandteile so voneinander zu trennen, dass sie sich unabhängig voneinander weiterentwickeln können, enthält die API die Summe der wichtigen Entscheidungen.

Nachdem Sie die Klassen und Interfaces der zu entwerfenden API mithilfe der Codebeispiele in mehreren Review- und Feedbackschleifen identifiziert haben, könnten Sie eine formale Spezifikation erstellen. Falls Sie keine Programmiersprachen-API, sondern eine Web-API entwerfen, würden die Beispiele typischerweise aus HTTP-Requests und Responses bestehen.