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

在審

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

本發明公開了一種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的特性并作出針對性的評價。

發明內容