[發明專利]接口文檔的生成方法、裝置及接口管理設備

在審

• 申請號: 202110693050.2
• 申請日: 2021-06-22
• 公開（公告）號: CN113419738A
• 公開（公告）日: 2021-09-21
• 發明（設計）人: 劉冬
• 申請（專利權）人: 未鯤（上海）科技服務有限公司
• 主分類號: G06F8/41
• 分類號: G06F8/41;G06F8/30
• 代理公司: 廣州三環專利商標代理有限公司 44202
• 代理人: 熊永強

本申請實施例提出了一種接口文檔的生成方法、裝置及接口管理設備，該方法包括：接口管理設備可響應于生成目標項目的目標接口文檔的觸發事件，從代碼倉庫中獲取目標項目對應的源碼文本，并調用語法分析器對目標項目的源碼文本進行解析，得到類信息；然后調用目標接口模型對類信息進行處理，生成目標接口文檔。可以無侵入的解析目標項目的源碼文本，得到更完整的類信息。并且，調用目標接口模型對類信息處理，可以提升目標接口文檔的完整性與準確性。

技術領域

本申請涉及軟件開發技術領域，尤其涉及一種接口文檔的生成方法、一種接口文檔的生成裝置、一種接口管理設備及一種計算機可讀存儲介質。

背景技術

目前，一個企業通常需要部署各種各樣的業務系統，每個業務系統都會按照各自的業務提供對應的接口。其中，每個接口對應的信息不同，例如每個接口采用的數據協議可以不同，有的接口可以采用SOAP協議，有的接口可以采用HTTP協議。又例如，每個接口可以擁有不同的參數信息等等。因此，如何對這些繁雜的接口進行管理，生成接口文檔，方便不同業務系統的開發和測試人員查閱接口是非常有必要的。

發明內容

本申請實施例提供了一種接口文檔的生成方法、裝置及接口管理設備，可以無侵入性的解析目標項目的源碼文本，得到更完成的類信息。并且，調用目標接口模型對類信息處理，可以根據類信息適應性的調整接口模型，提升目標接口文檔的完整性與準確性。

第一方面，本申請實施例提供了一種接口文檔的生成方法，該接口文檔的生成方法包括：

響應于生成目標項目的目標接口文檔的觸發事件，獲取目標項目的源碼文本；

調用語法分析器對目標項目的源碼文本進行解析，得到類信息，該類信息用于指示至少一個接口對象；

獲取預設的接口協議，并基于接口協議配置目標接口模型；

調用目標接口模型對類信息進行處理，生成目標接口文檔。

第二方面，本申請實施例提供了一種接口文檔的生成裝置，該接口文檔的生成裝置包括：

獲取單元，用于響應于生成目標項目的目標接口文檔的觸發事件，獲取目標項目的源碼文本；

解析單元，用于調用語法分析器對目標項目的源碼文本進行解析，得到類信息，該類信息用于指示至少一個接口對象；

該獲取單元還用于獲取預設的接口協議，并基于接口協議配置目標接口模型；

處理單元，用于調用目標接口模型對類信息進行處理，生成目標接口文檔。

第三方面，本申請實施提供了一種接口管理設備，該接口管理設備包括處理器、輸入設備、輸出設備和存儲器，該處理器、輸入設備、輸出設備和存儲器相互連接，其中，存儲器用于存儲計算機程序，計算機程序包括程序，處理器被配置用于調用所述程序，執行第一方面所述的接口文檔的生成方法。

第四方面，本申請實施提供了一種計算機可讀存儲介質，該計算機可讀存儲介質存儲有計算機程序，該計算機程序包括程序指令，該程序指令當被處理器執行時使處理器執行第一方面所述的接口文檔的生成方法。

在本申請實施例中，響應于生成目標項目的目標接口文檔的觸發事件，接口管理設備獲取目標項目的源碼文本，并調用語法分析器對目標項目的源碼文本進行解析，得到類信息；以及獲取預設的接口協議，并基于接口協議配置目標接口模型；調用目標接口模型對類信息進行處理，生成目標接口文檔。由于本申請實施例的接口管理設備通過語法分析器對目標項目的源碼文本進行解析，直接基于JAVA語法對源碼文本進行解析，無需引入額外的工具，對目標項目不存在侵入性。并且，通過語法分析器可以獲得的類信息中包含類的注釋、類的屬性的附加信息以及類的方法的附加信息，可以獲得更完整的類信息，以便后續生成的目標接口文檔更完整、更準確。除此之外，本申請實施例的接口文檔的生成方案無需人工參與，可以節省人力資源和時間資源。