Rapid API Design and Refactoring (RADAR)

API-First ist ein etabliertes Paradigma in der Softwareentwicklung, das APIs zu Beginn des Entwicklungsprozesses priorisiert und diese damit als einen essenziellen Baustein der Software positioniert. Das Design Practice Repository/Reference (DPR) schlägt dabei eine schrittweise Aktivität vor, die von der Problemanalyse bis hin zur iterativen Entwicklung einer ausgereiften API führt. Aktuell fehlt jedoch eine passende Werkzeugunterstützung, um diesen Design-Prozess effizient zu begleiten und die Produktivität zu steigern.
Im Rahmen dieser Studienarbeit wird eine desktopbasierte Anwendung entwickelt, die die Schritte «Model Domain» und «Identify API Endpoints and Operations» des DPR unterstützt. Anforderungen werden dabei in Form von Use Cases und Job Stories erfasst und in die HTTP- und Protobuf-Services der Interface Description Language (IDL) TypeSpec transformiert. Ziel ist es, eine plattformunabhängige Lösung bereitzustellen, die die Erstellung von API-Prototypen beschleunigt und vereinfacht. Dabei steht, aufgrund der nutzer- und geschäftszentrierten Perspektive der Eingabe-Formate, die Berücksichtigung der Bedürfnisse und Erwartungen der API-Anwender im Mittelpunkt.
Das methodische Vorgehen umfasst mehrere Phasen: In der Anforderungsanalyse werden Stakeholder-Rollen und deren Bedürfnisse analysiert, um ein präzises Verständnis der Problemstellung zu gewinnen. Architekturentscheidungen, wie der Einsatz von ANTLR zur Generierung von Lexer und Parser sowie Electron als Laufzeitumgebung, werden bewusst getroffen, um die Anforderungen an die Arbeit sicherzustellen. Es wird zudem ein universelles Zwischenformat entwickelt, um die Wartbarkeit und Flexibilität der Anwendung langfristig zu gewährleisten.
Die Applikation stellt einen innovativen Ansatz für Rapid API Prototyping dar, da sie als erste Lösung ihrer Art Use Cases und Job Stories direkt in TypeSpec transformiert. Sie leistet damit einen wichtigen Beitrag zur Verbesserung der Effizienz und Qualität in der API-Entwicklung. Eine Erweiterung der Applikation könnte den praktischen Nutzen weiter steigern, beispielsweise durch die Implementierung zusätzlicher TypeSpec-Formate als Ausgabe oder die Unterstützung alternativer IDLs.