Do RESTful API design rules have an impact on the understandability of Web APIs?Journal First
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.
Fri 7 JunDisplayed time zone: Chennai, Kolkata, Mumbai, New Delhi change
16:00 - 17:35 | Session 7B: Conformance Checking & Empirical Analysis 2Research Papers / Journal First Session Chair: Sridhar Chimalakonda, IIT Tirupathi, India | ||
16:00 25mResearch paper | How Do Microservice API Patterns Impact Understandability? A Controlled ExperimentResearch Paper Research Papers A: Justus Bogner Vrije Universiteit Amsterdam, A: Olaf Zimmermann University of Applied Sciences of Eastern Switzerland (OST), A: Pawel Wójcik University of Science and Technology in Cracow Pre-print | ||
16:25 25mResearch paper | Experimental Evaluation of Energy Efficiency Tactics in Industry: Results and Lessons LearnedResearch Paper Research Papers A: Markus Funke Vrije Universiteit Amsterdam, A: Patricia Lago Vrije Universiteit Amsterdam, A: Esther Adenekan Vrije Universiteit Amsterdam, A: Ivano Malavolta Vrije Universiteit Amsterdam, A: Ilja Heitlager Schuberg Philis Pre-print | ||
16:50 25mResearch paper | Characterizing Software Architectural Metrics for Continuous Compliance in the Automotive DomainResearch Paper Research Papers A: Tiziano Santilli Gran Sasso Science Institute (GSSI), A: Marco De Luca Federico II University of Naples, A: Patrizio Pelliccione Gran Sasso Science Institute, L'Aquila, Italy, A: Domenico Amalfitano University of Naples Federico II, A: Anna Rita Fasolino Federico II University of Naples | ||
17:15 20mPaper | Do RESTful API design rules have an impact on the understandability of Web APIs?Journal First Journal First A: Justus Bogner Vrije Universiteit Amsterdam, A: Sebastian Kotstein Reutlingen University, A: Timo Pfaff Link to publication DOI |