中文

面向物联网应用的 REST API 语言质量评估

软件工程 2022-05-16 v1

摘要

物联网(IoT)是一项不断发展的技术,它依赖于相互连接的“物”从对等设备收集数据并通过 API(应用程序编程接口)将数据发送到服务器。这些 API 的设计质量直接影响其可理解性和可重用性。本研究关注面向物联网应用的 REST API 的语言设计质量,并通过检测其中的语言模式与反模式来评估其语言质量。语言反模式是指在命名、文档和标识符选择方面的不良实践。相反,语言模式代表了 API 设计的最佳实践。因此,语言模式及其对应的反模式是成对的对比关系。我们提出了 SARAv2(Semantic Analysis of REST APIs version two,REST API 语义分析第二版)方法,用于对面向物联网应用的 REST API 进行句法和语义分析。基于 SARAv2 方法,我们开发了 REST-Ling 工具,并对九种语言反模式的检测结果进行了实证验证。我们分析了 19 个面向物联网应用的 REST API。检测结果表明,语言反模式普遍存在,且 REST-Ling 工具能够以超过 80% 的平均准确率检测其中的语言模式与反模式。此外,该工具检测语言反模式的平均耗时为秒级,即 8.396 秒。我们发现,尽管存在不良实践,API 总体上遵循良好的语言实践。

关键词

引用

@article{arxiv.2205.06533,
  title  = {Assessing the Linguistic Quality of REST APIs for IoT Applications},
  author = {Francis Palma and Tobias Olsson and Anna Wingkvist and Javier Gonzalez-Huerta},
  journal= {arXiv preprint arXiv:2205.06533},
  year   = {2022}
}