[发明专利]一种REST API设计质量评估方法

说明书

本发明公开了一种REST API设计质量评估方法，其步骤包括：1)建立一套RESTful规范体系；2)获取或构建API说明文档数据集，并按照API类别信息对文档分类，得到多个领域数据集；3)解析每一API说明文档，提取该API说明文档的版本号，然后根据版本号为该API说明文档构建对应的语法树；4)根据该RESTful规范体系检测各语法树的成分信息能否实现，确定REST API的评估参考值；5)针对一待检测REST API，确定该待检测REST API的评估值P；结合待检测REST API的领域j以及对应领域评估参考值P_j，评估得到该待检测REST API的RESTful程度。

技术领域

本发明涉及一种REST API设计质量评估方法，并结合了REST API综合发展现状以及领域特征，属于计算机软件技术领域。

背景技术

Web服务在应用程序的开发中扮演着重要的角色，面向服务的体系结构(SOA)，特别是微服务(microservice)体系结构，是构建应用程序时的常见实践。越来越多的应用程序使用面向服务的体系结构开发，而REST(Representational State Transfer，表现层状态转移)是最流行的网络服务架构风格。

REST基于HTTP协议，适用于通过HTTP协议提供服务、资源以网络实体的形式呈现、并通过HTTP标准方法进行请求操作的网络服务，它已经成为大多数服务商提供网络服务的标准方式。

尽管如此，REST仅仅是一种架构风格，没有提供标准规范。这意味着开发人员在开放服务时需要自行做出某些决策，这会导致不同的API设计，甚至有些是糟糕的设计决策，市场上的网络服务接口质量参差不齐。有些不规范设计比如接口命名不规范、没有正确使用HTTP方法、资源粒度设计不合理等，导致API机器不可读、人类不友好，埋没了其使用、学术以及经济价值，甚至可能造成服务的业务逻辑溢出造成安全隐患。因此API设计质量分析、其RESTful程度评估，是目前需要的研究工作；REST API评价方法的研究对规范现在以及未来的网络服务市场具有重要意义。

当前REST API评价工作得到了学术界的关注，形成了一些相关成果。目前的一些研究工作的关注点主要在于基于REST API最佳实践的设计模式(反模式)的研究与检测，形成一个规范体系，然后对REST API进行评价。研究工作(Palma,Francis,Johann Dubois,Naouel Moha,andGuéhéneuc.Detection of REST patterns andantipatterns:a heuristics-based approach.In International Conference onService-Oriented Computing,pp.230-244.Springer,Berlin,Heidelberg,2014.)定义了八个REST反模式和五个设计模式，提出了基于启发式的SODA-R(面向服务的REST模式检测)RESTful系统中检测(反)模式的方法，并在12种广泛使用的REST API(包括BestBuy，Facebook和DropBox进行检测，结果表明SODA-R可以执行精度检测REST(反)模式。研究工作(Neumann,Andy,Nuno Laranjeiro,and Jorge Bernardino.An analysis of publicREST web service APIs.IEEE Transactions on Services Computing(2018).)分析了500个API的关键技术特性、对REST架构原则的遵从程度(例如，资源可寻址性)以及对最佳实践的遵从程度(例如，API版本控制)，观察到一些趋势(例如广泛的JSON支持、软件生成的文档)，只有0.8％的服务严格遵守所有REST原则。但是目前的RESTful评价工作所有API一概而论，没有考虑到不同领域API的特性并作出针对性的评价。

发明内容