[發明專利]一種REST API設計質量評估方法

在審

• 申請號: 202011456869.9
• 申請日: 2020-12-10
• 公開（公告）號: CN114625341A
• 公開（公告）日: 2022-06-14
• 發明（設計）人: 陳偉;吳國全;魏峻;周芯宇
• 申請（專利權）人: 中國科學院軟件研究所
• 主分類號: G06F8/20
• 分類號: G06F8/20
• 代理公司: 北京君尚知識產權代理有限公司 11200
• 代理人: 司立彬

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。