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

权利要求书

1.一种REST API设计质量评估方法，其步骤包括：

1)建立一套RESTful规范体系，从不同维度规范REST API设计，在每个维度下建立规范体系，并确定每条规范的度量规则；

2)获取或构建符合REST API说明文档规范的API说明文档数据集，并按照API类别信息对该API说明文档数据集中的API说明文档数据进行分类，得到多个领域数据集；

3)解析该API说明文档数据集中的每一API说明文档，提取该API说明文档的版本号，然后根据版本号为该API说明文档构建对应的语法树；

4)获取语法树的成分信息，根据该RESTful规范体系检测各成分信息能否实现；然后根据各语法树的成分信息能否实现情况，计算REST API的整体规范实现情况，以及不同领域API的规范实现情况，作为REST API的评估参考值；

5)针对一待检测REST API，解析该待检测REST API的API说明文档并为其构建对应的语法树H，根据该RESTful规范体系检测该语法树H的成分信息能否实现，确定该待检测RESTAPI的评估值P；结合该待检测REST API所属领域j以及步骤4)中得到的对应领域评估参考值P_j，对该待检测REST API进行评估，得到该待检测REST API在其所属领域的RESTful程度。

2.如权利要求1所述的方法，其特征在于，所述维度包括RESTful API的资源设计、HTTP交互设计、非功能性设计三个维度。

3.如权利要求1或2所述的方法，其特征在于，按照API类别信息对该说明文档数据集进行分类的方法为：

21)对该API说明文档数据集进行清洗，为每个API保留最新版本的API说明文档，并清除掉不包含路径信息的API说明文档；

22)提取API的类别信息，对于没有类别信息的API，在维护REST API的站点中检索其所属类别；然后根据类别信息对数据集进行分类，对每个类别的API说明文档进行抽样并对抽样结果进行合并，得到多个领域数据集。

4.如权利要求1所述的方法，其特征在于，得到REST API评价的参考值的方法为：

41)提取语法树中路径信息，根据该RESTful规范体系对路径命名进行规范验证；

42)提取语法树中属性信息，根据该RESTful规范体系对API属性使用规范进行验证；

43)对于每一条规范，根据该规范的验证结果计算全部API对于该规范的平均实现程度，以及不同领域API对于该规范的领域规范基准P_j。