Visualisierung von Interface Representation Patterns: Automatisierung und Werkzeugintegration

Ein Autorenteam der HSR erarbeitet zur Zeit mit externen Kooperationspartnern eine Patternsprache für messagebasierte Application Programming Interfaces (APIs). Die Verfasser dieser Bachelorarbeit entwarfen während ihrer Studienarbeit 50 Visualisierungen für diese Patternsprache, die es Dritten ermöglicht, eigene APIs anhand von Pattern-Icons zu dokumentieren.
Das Ziel dieser Bachelorarbeit war es, die Visualisierungen in Konzept und Umsetzung zu optimieren und einen Dokumentationsassistenten zur Gestaltung von Web-API-Beschreibungen basierend auf der Patternsprache zu entwickeln.
Der Dokumentationsassistent wurde als Web-Applikation prototypisch realisiert. Dieser Protoyp erlaubt es, ein bestehendes Web-API im OpenAPI Specification Format einzulesen und zu analysieren. Der Assistent visualisiert die Struktur des APIs mit Hilfe der Pattern-Icons und sucht darin anhand von Eigenschaften, Begriffen und hinterlegten API-Referenzen nach verwendeten Patterns. Diese werden dem Anwender in einer navigierbaren Diagrammhierarchie angezeigt. Das Resultat der Strukturanalyse und Pattern-Suche kann durch den Anwender überarbeitet werden. Den Benutzern des Dokumentationsassistenten steht alternativ die Möglichkeit zur Verfügung, ein API von Grund auf neu zu gestalten und über zu hinterlegende URI-Referenzen in der Freitextbeschreibung des APIs schlüsselwortbasiert nach Patterns zu suchen.
Die visuelle Darstellung des API mit den Pattern-Zuordnungen ist plattformunabhängig und komplementär zu den bisher verwendeten textuellen Formaten. Sie kann exportiert werden und gibt damit Dritten die Möglichkeit, einen schnellen Überblick über ein API zu erhalten und APIs zu vergleichen. Mit Hilfe der Kurzbeschreibungen zu den Pattern-Icons sowie Referenzen in die Patternsprache kann sich ein Benutzer der Applikation über die verwendeten Patterns informieren, was den Einarbeitungsaufwand bei API-Verwendung und -Wartung senkt.