Haben Design-Regeln Einfluss auf die Verständlichkeit von RESTful APIs? Ein kontrolliertes Experiment

Abstract

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.