首页> 外文会议>IEEE International Conference on Software Maintenance and Evolution >A First Look at the Deprecation of RESTful APIs: An Empirical Study
【24h】

A First Look at the Deprecation of RESTful APIs: An Empirical Study

机译:RESTful API的弃用初探:一项实证研究

获取原文

摘要

REpresentational State Transfer (REST) is considered as one standard software architectural style to build web APIs that can integrate software systems over the internet. However, while connecting systems, RESTful APIs might also break the dependent applications that rely on their services when they introduce breaking changes, e.g., an older version of the API is no longer supported. To warn developers promptly and thus prevent critical impact on downstream applications, a deprecated-removed model should be followed, and deprecation-related information such as alternative approaches should also be listed. While API deprecation analysis as a theme is not new, most existing work focuses on non-web APIs, such as the ones provided by Java and Android.To investigate RESTful API deprecation, we propose a framework called RADA (RESTful API Deprecation Analyzer). RADA is capable of automatically identifying deprecated API elements and analyzing impacted operations from an OpenAPI specification, a machine-readable profile for describing RESTful web service. We apply RADA on 2,224 OpenAPI specifications of 1,368 RESTful APIs collected from APIs.guru, the largest directory of OpenAPI specifications. Based on the data mined by RADA, we perform an empirical study to investigate how the deprecated-removed protocol is followed in RESTful APIs and characterize practices in RESTful API deprecation. The results of our study reveal several severe deprecation-related problems in existing RESTful APIs. Our implementation of RADA and detailed empirical results are publicly available for future intelligent tools that could automatically identify and migrate usage of deprecated RESTful API operations in client code.
机译:代表性状态转移(REST)被认为是一种构建Web API的标准软件体系结构样式,该API可以通过Internet集成软件系统。但是,在连接系统时,RESTful API可能会在引入重大更改时破坏依赖于其服务的依赖应用程序,例如,不再支持该API的较旧版本。为了及时警告开发人员,从而防止对下游应用程序造成严重影响,应遵循已弃用的已删除模型,并且还应列出与弃用有关的信息,例如替代方法。尽管API弃用分析并不是一个新主题,但大多数现有工作都集中在非Web API(例如Java和Android提供的API)上。为了研究RESTful API弃用,我们提出了一个名为RADA(RESTful API Deprecation Analyzer)的框架。 RADA能够自动识别已弃用的API元素,并根据OpenAPI规范(用于描述RESTful Web服务的机器可读配置文件)分析受影响的操作。我们对从APIs.guru(最大的OpenAPI规范目录)收集的1,368个RESTful API的2,224个OpenAPI规范应用RADA。基于RADA收集的数据,我们进行了一项实证研究,以研究RESTful API如何遵循已弃用的已删除协议,并描述RESTful API弃用的做法。我们的研究结果揭示了现有RESTful API中与折旧相关的几个严重问题。我们对RADA的实现和详细的经验结果可公开提供给将来的智能工具,这些工具可以自动识别和迁移客户端代码中已弃用的RESTful API操作的用法。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱:kefu@zhangqiaokeyan.com

京公网安备:11010802029741号 ICP备案号:京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有
  • 客服微信

  • 服务号