Browsing by Author "Pfaff, Timo"

Filter results by typing the first few letters
Now showing 1 - 3 of 3
  • Thumbnail Image
    ItemOpen Access
    Do RESTful API design rules have an impact on the understandability of Web APIs?
    (2023) Bogner, Justus; Kotstein, Sebastian; Pfaff, Timo
    Context. Web APIs are one of the most used ways to expose application functionality on the Web, and their understandability is important for efficiently using the provided resources. While many API design rules exist, empirical evidence for the effectiveness of most rules is lacking. Objective. We therefore wanted to study 1) the impact of RESTful API design rules on understandability, 2) if rule violations are also perceived as more difficult to understand, and 3) if demographic attributes like REST-related experience have an influence on this. Method. We conducted a controlled Web-based experiment with 105 participants, from both industry and academia and with different levels of experience. Based on a hybrid between a crossover and a between-subjects design, we studied 12 design rules using API snippets in two complementary versions: one that adhered to a rule and one that was a violation of this rule. Participants answered comprehension questions and rated the perceived difficulty. Results. For 11 of the 12 rules, we found that violation performed significantly worse than rule for the comprehension tasks. Regarding the subjective ratings, we found significant differences for 9 of the 12 rules, meaning that most violations were subjectively rated as more difficult to understand. Demographics played no role in the comprehension performance for violation . Conclusions. Our results provide first empirical evidence for the importance of following design rules to improve the understandability of Web APIs, which is important for researchers, practitioners, and educators.
  • Thumbnail Image
    ItemOpen Access
    Haben Design-Regeln Einfluss auf die Verständlichkeit von RESTful APIs? Ein kontrolliertes Experiment
    (2021) Pfaff, Timo
    REST wird in der Praxis häufig verwendet, um Programmierschnittstellen zu erstellen. Da keine einheitliche Spezifikation für REST existiert, wurden in verschiedenen wissenschaftlichen Arbeiten Best Practices und Design-Regeln definiert, um die Entwickler bei der Erstellung von REST APIs zu unterstützen. Aufgrund der Vielzahl an Regeln und Best Practices stehen die Entwickler vor dem Problem auszuwählen, welche von diesen sie umsetzen sollen. Die Auswahl wird durch das Fehlen einer empirischen Grundlage für den Effekt der Regeln zusätzlich erschwert. Aus den genannten Gründen wurde in dieser Arbeit untersucht, ob Design-Regeln einen Einfluss auf die Verständlichkeit von REST APIs haben. Dies wurde anhand eines kontrollierten Experiments überprüft, welches online über dasWerkzeug Limesurvey durchgeführt wurde. Die Aufgabe der 105 Probanden war es, Verständnisaufgaben zu verschiedenen REST API Schnipseln zu beantworten. Zusätzlich bewerteten die Probanden die Schwierigkeit, das Schnipsel zu verstehen. Die APIs existierten dabei in zwei Versionen. Eine Version für die Einhaltung der Regeln und eine weitere Version, bei der gegen die Regeln verstoßen wurde. Ziel der Studie war es zu analysieren, welche der untersuchten Regeln einen signifikanten Einfluss auf die Verständlichkeit haben. Gemessen wurde die Verständlichkeit unter Verwendung einer geeigneten Metrik, welche sich aus der benötigten Zeit und der Korrektheit zusammensetzt. Außerdem wurde der Einfluss auf die wahrgenommenen Schwierigkeit untersucht. Zuletzt wurde überprüft, ob die Ergebnisse durch die unterschiedlichen Erfahrungen der Teilnehmer beeinflusst wurden. Mit einer Ausnahme wurde in Bezug auf die Verständlichkeit für alle untersuchten Regeln ein signifikant besseres Ergebnis bei Einhaltung der Regeln gemessen. Ein ähnliches Resultat ist auch für die wahrgenommene Schwierigkeit zu beobachten. Abgesehen von der genannten Ausnahme wurde die Version mit Regeleinhaltung von den Probanden signifikant leichter bewertet. Für den Einfluss der Erfahrung konnten signifikante Wechselwirkungen mit der Anzahl an Jahren, der Kenntnis über das Reifegradmodell und der Perspektive bei der Arbeit mit REST APIs beobachtet werden. Die gemessenen Effektstärken für diese Korrelationen werden als schwach eingestuft. Für die unterschiedlichen Berufsgruppen konnte keine signifikante Korrelation gefunden werden. Bei der Bewertung der Ergebnisse ist zu berücksichtigen, dass lediglich ein Teil der vorhandenen Regeln untersucht wurde. Weiterhin wurden Regeln ausgewählt, für die ein großer Effekt erwartet wurde. Insgesamt zeigen die Ergebnisse, dass die Verständlichkeit von REST APIs verbessert werden kann, wenn die dafür aufgestellten Regeln beachtet werden. Dies gilt unabhängig der bisherigen Erfahrungen mit REST APIs. Um die mit der Verständlichkeit verbundene Nutzbarkeit und Wartbarkeit zu steigern, wird auf Basis der Ergebnisse empfohlen, bei der Erstellung von REST APIs auf die Einhaltung der positiv evaluierten Regeln zu achten.
  • Thumbnail Image
    ItemOpen Access
    Implementierung eines Bots zum Vorschlagen automatisch durchgeführter Refactorings
    (2018) Pfaff, Timo
    Software altert über die Jahre und verliert an Struktur. Um diesem Prozess entgegenzuwirken, werden in der Softwareentwicklung Refactorings eingesetzt. Refactorings sind Änderungen des Programmcodes, um die Qualität zu steigern, ohne dabei das Verhalten der Software zu verändern. Refactorings stellen somit einen wichtigen Bestandteil dar, um die Softwarequalität auch über mehrere Jahre in einem guten Zustand zu halten. Gleichzeitig werden zum Durchführen von Refactorings aber Ressourcen, wie zum Beispiel Personenstunden, benötigt, die wiederum den Unterschied zwischen Erfolg und Misserfolg eines Softwareprojekts bedeuten können. Um Ressourcen zu sparen, befasst sich diese Bachelorarbeit mit der Implementierung eines Bots, der automatisch Refactorings durchführt und diese dem Entwickler vor dem Übernehmen der Änderungen in den Hauptentwicklungszweig zum Review anbietet. Die Änderungen sollen nicht automatisch übernommen werden, da ein Fehler während des Refactorings gerade bei sicherheitskritischer Software schwerwiegende Folgen haben kann. Der Bot wurde anschließend anhand eines Beispielsprojekts getestet und gefundene Probleme wurden diskutiert. Des Weiteren wurden zwei Evaluationskonzepte vorgestellt, mit denen der Bot auf verschiedene Kriterien evaluiert werden kann. Das Ergebnis der Arbeit ist die Implementierung des Bots, der die genannte Grundfunktionalität bereitstellt und Refactorings an realen Projekten durchführen kann.