{"status":"ok","message-type":"work","message-version":"1.0.0","message":{"indexed":{"date-parts":[[2026,5,5]],"date-time":"2026-05-05T10:48:53Z","timestamp":1777978133702,"version":"3.51.4"},"reference-count":34,"publisher":"Springer Science and Business Media LLC","issue":"6","license":[{"start":{"date-parts":[[2023,9,26]],"date-time":"2023-09-26T00:00:00Z","timestamp":1695686400000},"content-version":"tdm","delay-in-days":0,"URL":"https:\/\/creativecommons.org\/licenses\/by\/4.0"},{"start":{"date-parts":[[2023,9,26]],"date-time":"2023-09-26T00:00:00Z","timestamp":1695686400000},"content-version":"vor","delay-in-days":0,"URL":"https:\/\/creativecommons.org\/licenses\/by\/4.0"}],"funder":[{"DOI":"10.13039\/501100009534","name":"Universit\u00e4t Stuttgart","doi-asserted-by":"crossref","id":[{"id":"10.13039\/501100009534","id-type":"DOI","asserted-by":"crossref"}]}],"content-domain":{"domain":["link.springer.com"],"crossmark-restriction":false},"short-container-title":["Empir Software Eng"],"published-print":{"date-parts":[[2023,11]]},"abstract":"<jats:title>Abstract<\/jats:title><jats:sec>\n                <jats:title>Context<\/jats:title>\n                <jats:p>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.<\/jats:p>\n              <\/jats:sec><jats:sec>\n                <jats:title>Objective<\/jats:title>\n                <jats:p>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.<\/jats:p>\n              <\/jats:sec><jats:sec>\n                <jats:title>Method<\/jats:title>\n                <jats:p>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 <jats:italic>crossover<\/jats:italic> and a <jats:italic>between-subjects<\/jats:italic> design, we studied 12 design rules using API snippets in two complementary versions: one that adhered to a <jats:italic>rule<\/jats:italic> and one that was a <jats:italic>violation<\/jats:italic> of this rule. Participants answered comprehension questions and rated the perceived difficulty.<\/jats:p>\n              <\/jats:sec><jats:sec>\n                <jats:title>Results<\/jats:title>\n                <jats:p>For 11 of the 12 rules, we found that <jats:italic>violation<\/jats:italic> performed significantly worse than <jats:italic>rule<\/jats:italic> 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 <jats:italic>violation<\/jats:italic>.<\/jats:p>\n              <\/jats:sec><jats:sec>\n                <jats:title>Conclusions<\/jats:title>\n                <jats:p>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.<\/jats:p>\n              <\/jats:sec>","DOI":"10.1007\/s10664-023-10367-y","type":"journal-article","created":{"date-parts":[[2023,9,26]],"date-time":"2023-09-26T02:01:37Z","timestamp":1695693697000},"update-policy":"https:\/\/doi.org\/10.1007\/springer_crossmark_policy","source":"Crossref","is-referenced-by-count":15,"title":["Do RESTful API design rules have an impact on the understandability of Web APIs?"],"prefix":"10.1007","volume":"28","author":[{"ORCID":"https:\/\/orcid.org\/0000-0001-5788-0991","authenticated-orcid":false,"given":"Justus","family":"Bogner","sequence":"first","affiliation":[],"role":[{"role":"author","vocabulary":"crossref"}]},{"given":"Sebastian","family":"Kotstein","sequence":"additional","affiliation":[],"role":[{"role":"author","vocabulary":"crossref"}]},{"given":"Timo","family":"Pfaff","sequence":"additional","affiliation":[],"role":[{"role":"author","vocabulary":"crossref"}]}],"member":"297","published-online":{"date-parts":[[2023,9,26]]},"reference":[{"issue":"4","key":"10367_CR1","doi-asserted-by":"publisher","first-page":"94","DOI":"10.1007\/s10664-021-10072-8","volume":"27","author":"S Baltes","year":"2022","unstructured":"Baltes S, Ralph P (2022) Sampling in software engineering research: A critical review and guidelines. Empirical Software Engineering 27(4):94. https:\/\/doi.org\/10.1007\/s10664-021-10072-8","journal-title":"Empirical Software Engineering"},{"key":"10367_CR2","doi-asserted-by":"publisher","unstructured":"Bogner J, Fritzsch J, Wagner S, Zimmermann A (2019) Microservices in Industry: Insights into Technologies , Characteristics , and Software Quality. In: 2019 IEEE International Conference on Software Architecture Companion (ICSA-C), IEEE, Hamburg, Germany, pp 187\u2013195, https:\/\/doi.org\/10.1109\/ICSA-C.2019.00041, https:\/\/ieeexplore.ieee.org\/document\/8712375\/","DOI":"10.1109\/ICSA-C.2019.00041"},{"key":"10367_CR3","doi-asserted-by":"publisher","unstructured":"Cohen J (1988) Statistical Power Analysis for the Behavioral Sciences, zeroth edn. Routledge ,https:\/\/doi.org\/10.4324\/9780203771587, https:\/\/www.taylorfrancis.com\/books\/9781134742707","DOI":"10.4324\/9780203771587"},{"issue":"2","key":"10367_CR4","doi-asserted-by":"publisher","first-page":"115","DOI":"10.1145\/514183.514185","volume":"2","author":"RT Fielding","year":"2002","unstructured":"Fielding RT, Taylor RN (2002) Principled Design of the Modern Web Architecture. ACM Trans Internet Technol 2(2):115\u2013150","journal-title":"ACM Trans Internet Technol"},{"key":"10367_CR5","doi-asserted-by":"publisher","first-page":"55","DOI":"10.1109\/ICSA.2017.40","volume-title":"2017 IEEE International Conference on Software Architecture (ICSA)","author":"F Haupt","year":"2017","unstructured":"Haupt F, Leymann F, Scherer A, Vukojevic-Haupt K (2017) A Framework for the Structural Analysis of REST APIs. 2017 IEEE International Conference on Software Architecture (ICSA). IEEE, Gothenburg, Sweden, pp 55\u201358"},{"issue":"3\u20134","key":"10367_CR6","doi-asserted-by":"publisher","first-page":"291","DOI":"10.1007\/s00450-017-0384-1","volume":"33","author":"F Haupt","year":"2018","unstructured":"Haupt F, Leymann F, Vukojevic-Haupt K (2018) API governance support through the structural analysis of REST APIs. Computer Science - Research and Development 33(3\u20134):291\u2013303","journal-title":"Computer Science - Research and Development"},{"key":"10367_CR7","unstructured":"Jacobson D, Brail G, Woods D (2011) APIs: A Strategy Guide. O\u2019Reilly Media,Inc"},{"key":"10367_CR8","doi-asserted-by":"publisher","unstructured":"Jedlitschka A, Ciolkowski M, Pfahl D (2008) Reporting Experiments in Software Engineering. In: Guide to Advanced Empirical Software Engineering, Springer London, London, pp 201\u2013228, https:\/\/doi.org\/10.1007\/978-1-84800-044-5_8, http:\/\/link.springer.com\/10.1007\/978-1-84800-044-5_8","DOI":"10.1007\/978-1-84800-044-5_8"},{"issue":"1\u20132","key":"10367_CR9","doi-asserted-by":"publisher","first-page":"81","DOI":"10.1093\/biomet\/30.1-2.81","volume":"30","author":"MG Kendall","year":"1938","unstructured":"Kendall MG (1938) A New Measure of Rank Correlation. Biometrika 30(1\u20132):81\u201393. https:\/\/doi.org\/10.1093\/biomet\/30.1-2.81","journal-title":"Biometrika"},{"key":"10367_CR10","doi-asserted-by":"publisher","unstructured":"Kotstein S, Bogner J (2021) Which RESTful API Design Rules Are Important and How Do They Improve Software Quality? A Delphi Study with Industry Experts. In: Service-Oriented Computing. SummerSOC 2021. Communications in Computer and Information Science, Vol 1429, Springer International Publishing, pp 154\u2013173, https:\/\/doi.org\/10.1007\/978-3-030-87568-8_10, http:\/\/dx.doi.org\/10.1007\/978-3-030-87568-8_10https:\/\/link.springer.com\/10.1007\/978-3-030-87568-8_10","DOI":"10.1007\/978-3-030-87568-8_10"},{"key":"10367_CR11","unstructured":"Martin Fowler (2010) Richardson Maturity Model. https:\/\/martinfowler.com\/articles\/richardsonMaturityModel.html. Last accessed 26 March 2021"},{"key":"10367_CR12","unstructured":"Mass\u00e9 M (2011) REST API Design Rulebook. O\u2019Reilly Media, Inc., Sebastopol, CA, USA, https:\/\/www.oreilly.com\/library\/view\/rest-api-design\/9781449317904\/"},{"key":"10367_CR13","doi-asserted-by":"publisher","unstructured":"Neuh\u00e4user M (2011) Wilcoxon-Mann-Whitney Test. In: Lovric M (ed) International Encyclopedia of Statistical Science, Springer Berlin Heidelberg, Berlin, Heidelberg, pp 1656\u20131658, https:\/\/doi.org\/10.1007\/978-3-642-04898-2_615, http:\/\/link.springer.com\/10.1007\/978-3-642-04898-2_615","DOI":"10.1007\/978-3-642-04898-2_615"},{"key":"10367_CR14","unstructured":"Neumann A, Laranjeiro N, Bernardino J (2018) An Analysis of Public REST Web Service APIs. IEEE Transactions on Services Computing PP(c):1\u20131"},{"key":"10367_CR15","doi-asserted-by":"publisher","first-page":"230","DOI":"10.1007\/978-3-662-45391-9_16","volume-title":"Service-Oriented Computing","author":"F Palma","year":"2014","unstructured":"Palma F, Dubois J, Moha N, Gu\u00e9h\u00e9neuc YG (2014) Detection of rest patterns and antipatterns: A heuristics-based approach. Service-Oriented Computing. Springer, Berlin Heidelberg, Berlin, Heidelberg, pp 230\u2013244"},{"issue":"02","key":"10367_CR16","doi-asserted-by":"publisher","first-page":"1742001","DOI":"10.1142\/S0218843017420011","volume":"26","author":"F Palma","year":"2017","unstructured":"Palma F, Gonzalez-Huerta J, Founi M, Moha N, Tremblay G, Gu\u00e9h\u00e9neuc YG (2017) Semantic Analysis of RESTful APIs for the Detection of Linguistic Patterns and Antipatterns. International Journal of Cooperative Information Systems 26(02):1742001","journal-title":"International Journal of Cooperative Information Systems"},{"key":"10367_CR17","first-page":"171","volume-title":"Hacid H, Kao O, Mecella M, Moha N, Paik Hy","author":"F Palma","year":"2021","unstructured":"Palma F, Zarraa O, Sadia A (2021) Are developers equally concerned about making their apis restful and the linguistic quality? a study on google apis. In: Computing Service-Oriented, International Springer (eds) Hacid H, Kao O, Mecella M, Moha N, Paik Hy. Publishing, Cham, pp 171\u2013187"},{"key":"10367_CR18","doi-asserted-by":"publisher","unstructured":"Palma F, Olsson T, Wingkvist A, Ahlgren F, Toll D (2022a) Investigating the linguistic design quality of public, partner, and private rest apis. In: 2022 IEEE International Conference on Services Computing (SCC), pp 20\u201330, https:\/\/doi.org\/10.1109\/SCC55611.2022.00017","DOI":"10.1109\/SCC55611.2022.00017"},{"key":"10367_CR19","doi-asserted-by":"publisher","unstructured":"Palma F, Olsson T, Wingkvist A, Gonzalez-Huerta J (2022b) Assessing the linguistic quality of rest apis for iot applications. J Syst Softw 191(C), https:\/\/doi.org\/10.1016\/j.jss.2022.111369,","DOI":"10.1016\/j.jss.2022.111369"},{"key":"10367_CR20","doi-asserted-by":"publisher","first-page":"31","DOI":"10.1007\/978-1-4614-7518-7_2","volume-title":"Web Services Foundations","author":"C Pautasso","year":"2014","unstructured":"Pautasso C (2014) RESTful web services: Principles, patterns, emerging technologies. Web Services Foundations, vol 9781461475. Springer, New York, New York, NY, pp 31\u201351"},{"key":"10367_CR21","doi-asserted-by":"publisher","unstructured":"Pautasso C, Zimmermann O, Leymann F (2008) Restful web services vs. \u201cbig\" web services: Making the right architectural decision. In: Proceedings of the 17th International Conference on World Wide Web, Association for Computing Machinery, New York, NY, USA, WWW \u201908, p 805-814, https:\/\/doi.org\/10.1145\/1367497.1367606,","DOI":"10.1145\/1367497.1367606"},{"key":"10367_CR22","doi-asserted-by":"publisher","first-page":"157","DOI":"10.1007\/978-3-319-46295-0_10","volume-title":"Service-Oriented Computing","author":"F Petrillo","year":"2016","unstructured":"Petrillo F, Merle P, Moha N, Gu\u00e9h\u00e9neuc YG (2016) Are REST APIs for Cloud Computing Well-Designed? An Exploratory Study. Service-Oriented Computing. Springer International Publishing, Cham, pp 157\u2013170"},{"key":"10367_CR23","doi-asserted-by":"publisher","first-page":"354","DOI":"10.1007\/978-3-642-35063-4_26","volume-title":"Web Information Systems Engineering - WISE 2012","author":"D Renzel","year":"2012","unstructured":"Renzel D, Schlebusch P, Klamma R (2012) Today\u2019s Top \u201cRESTful\" Services and Why They Are Not RESTful. Web Information Systems Engineering - WISE 2012. Springer, Berlin Heidelberg, Berlin, Heidelberg, pp 354\u2013367"},{"key":"10367_CR24","volume-title":"RESTful Web Services","author":"L Richardson","year":"2007","unstructured":"Richardson L, Ruby S (2007) RESTful Web Services. O\u2019Reilly Media, Sebastopol, CA, USA"},{"key":"10367_CR25","doi-asserted-by":"crossref","unstructured":"Rodr\u00edguez C, Baez M, Daniel F, Casati F, Trabucco J, Canali L, Percannella G (2016) REST APIs: A large-scale analysis of compliance with principles and best practices. In: Lecture Notes in Computer Science, Springer, vol 9671","DOI":"10.1007\/978-3-319-38791-8_2"},{"key":"10367_CR26","doi-asserted-by":"publisher","unstructured":"Sawilowsky SS (2009) New Effect Size Rules of Thumb. Journal of Modern Applied Statistical Methods 8(2):597\u2013599, https:\/\/doi.org\/10.22237\/jmasm\/1257035100, http:\/\/digitalcommons.wayne.edu\/jmasm\/vol8\/iss2\/26","DOI":"10.22237\/jmasm\/1257035100"},{"issue":"3","key":"10367_CR27","doi-asserted-by":"publisher","first-page":"595","DOI":"10.1109\/TSE.2019.2901468","volume":"47","author":"S Scalabrino","year":"2021","unstructured":"Scalabrino S, Bavota G, Vendome C, Linares-V\u00e1squez M, Poshyvanyk D, Oliveto R (2021) Automatically assessing code understandability. IEEE Trans Software Eng 47(3):595\u2013613. https:\/\/doi.org\/10.1109\/TSE.2019.2901468","journal-title":"IEEE Trans Software Eng"},{"key":"10367_CR28","doi-asserted-by":"publisher","unstructured":"Schermann G, Cito J, Leitner P (2016) All the Services Large and Micro: Revisiting Industrial Practice in Services Computing. In: Norta A, Gaaloul W, Gangadharan GR, Dam HK (eds) Lecture Notes in Computer Science (Including Subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics), vol 9586, Springer Berlin Heidelberg, Berlin, Heidelberg, pp 36\u201347, https:\/\/doi.org\/10.1007\/978-3-662-50539-7_4, http:\/\/link.springer.com\/10.1007\/978-3-662-50539-7","DOI":"10.1007\/978-3-662-50539-7_4"},{"issue":"1","key":"10367_CR29","doi-asserted-by":"publisher","first-page":"561","DOI":"10.1146\/annurev.ps.46.020195.003021","volume":"46","author":"JP Shaffer","year":"1995","unstructured":"Shaffer JP (1995) Multiple Hypothesis Testing. Annual Review of Psychology 46(1):561\u2013584. https:\/\/doi.org\/10.1146\/annurev.ps.46.020195.003021","journal-title":"Annual Review of Psychology"},{"key":"10367_CR30","doi-asserted-by":"publisher","unstructured":"Shapiro SS, Wilk MB (1965) An Analysis of Variance Test for Normality (Complete Samples). Biometrika 52(3\/4):591. https:\/\/doi.org\/10.2307\/2333709, https:\/\/www.jstor.org\/stable\/2333709?origin=crossref","DOI":"10.2307\/2333709"},{"key":"10367_CR31","doi-asserted-by":"publisher","unstructured":"Vegas S, Apa C, Juristo N (2016) Crossover Designs in Software Engineering Experiments: Benefits and Perils. IEEE Transactions on Software Engineering 42(2):120\u2013135. https:\/\/doi.org\/10.1109\/TSE.2015.2467378, http:\/\/ieeexplore.ieee.org\/document\/7192651\/","DOI":"10.1109\/TSE.2015.2467378"},{"key":"10367_CR32","unstructured":"Webber J, Parastatidis S, Robinson I (2010) REST in Practice: Hypermedia and Systems Architecture, 1st edn. O\u2019Reilly Media, Inc., Sebastopol, USA"},{"key":"10367_CR33","doi-asserted-by":"publisher","unstructured":"Wohlin C, Runeson P, H\u00f6st M, Ohlsson MC, Regnell B, Wessl\u00e9n A (2012) Planning. In: Experimentation in Software Engineering, Springer Berlin Heidelberg, Berlin, Heidelberg , pp 89\u2013116, https:\/\/doi.org\/10.1007\/978-3-642-29044-2_8","DOI":"10.1007\/978-3-642-29044-2_8"},{"key":"10367_CR34","doi-asserted-by":"publisher","unstructured":"Wyrich M, Bogner J, Wagner S (2022) 40 years of designing code comprehension experiments: A systematic mapping study. https:\/\/doi.org\/10.48550\/ARXIV.2206.11102","DOI":"10.48550\/ARXIV.2206.11102"}],"container-title":["Empirical Software Engineering"],"original-title":[],"language":"en","link":[{"URL":"https:\/\/link.springer.com\/content\/pdf\/10.1007\/s10664-023-10367-y.pdf","content-type":"application\/pdf","content-version":"vor","intended-application":"text-mining"},{"URL":"https:\/\/link.springer.com\/article\/10.1007\/s10664-023-10367-y\/fulltext.html","content-type":"text\/html","content-version":"vor","intended-application":"text-mining"},{"URL":"https:\/\/link.springer.com\/content\/pdf\/10.1007\/s10664-023-10367-y.pdf","content-type":"application\/pdf","content-version":"vor","intended-application":"similarity-checking"}],"deposited":{"date-parts":[[2024,3,19]],"date-time":"2024-03-19T09:47:03Z","timestamp":1710841623000},"score":1,"resource":{"primary":{"URL":"https:\/\/link.springer.com\/10.1007\/s10664-023-10367-y"}},"subtitle":[],"short-title":[],"issued":{"date-parts":[[2023,9,26]]},"references-count":34,"journal-issue":{"issue":"6","published-print":{"date-parts":[[2023,11]]}},"alternative-id":["10367"],"URL":"https:\/\/doi.org\/10.1007\/s10664-023-10367-y","relation":{},"ISSN":["1382-3256","1573-7616"],"issn-type":[{"value":"1382-3256","type":"print"},{"value":"1573-7616","type":"electronic"}],"subject":[],"published":{"date-parts":[[2023,9,26]]},"assertion":[{"value":"13 July 2023","order":1,"name":"accepted","label":"Accepted","group":{"name":"ArticleHistory","label":"Article History"}},{"value":"26 September 2023","order":2,"name":"first_online","label":"First Online","group":{"name":"ArticleHistory","label":"Article History"}}],"article-number":"132"}}