RESTful API 设计规则是否影响 Web API 的可理解性？一项基于 Web 的 API 描述实验
软件工程
2024-09-12 v3
摘要
背景：Web API 是在 Web 上暴露应用功能最常用的方式之一，其可理解性对于高效使用所提供资源十分重要。尽管存在众多 API 设计规则，但关于大多数规则有效性的经验证据仍然缺乏。目标：因此我们欲研究 1）RESTful API 设计规则对可理解性的影响，2）规则违背是否也被感知为更难理解，以及 3）如 REST 相关经验等人口统计学属性是否具有影响。方法：我们开展了一项有 105 名参与者（来自工业界与学术界，经验水平各异）参与的受控 Web 实验。基于交叉设计与被试间设计的混合，我们使用两种互补版本的 API 片段研究了 12 条设计规则：一为遵循某“规则”的版本，一为该“规则”的“违背”版本。参与者回答理解问题并评价感知难度。结果：在 12 条规则中的 11 条上，我们发现“违背”版本在理解任务上的表现显著差于“规则”版本。就主观评分而言，我们在 12 条中的 9 条上发现显著差异，即多数违背被主观评价为更难理解。人口统计学属性对“违背”版本的理解表现无影响。结论：我们的结果提供了遵循设计规则以提升 Web API 可理解性重要性的首批经验证据，这对研究者、从业者和教育者均十分重要。
引用
@article{arxiv.2305.07346,
title = {Do RESTful API Design Rules Have an Impact on the Understandability of Web APIs? A Web-Based Experiment with API Descriptions},
author = {Justus Bogner and Sebastian Kotstein and Timo Pfaff},
journal= {arXiv preprint arXiv:2305.07346},
year = {2024}
}
备注
Accepted at Empirical Software Engineering (EMSE)