[發明專利]接口文檔生成方法、裝置及可讀存儲介質

在審

• 申請號: 201911418878.6
• 申請日: 2019-12-31
• 公開（公告）號: CN111240653A
• 公開（公告）日: 2020-06-05
• 發明（設計）人: 秦偲晟;朱傳波;楊少華;陶靜煜;胡陳晨
• 申請（專利權）人: 瑞庭網絡技術（上海）有限公司
• 主分類號: G06F8/30
• 分類號: G06F8/30;G06F8/73
• 代理公司: 北京潤澤恒知識產權代理有限公司 11319
• 代理人: 莎日娜

本發明實施例提供了一種接口文檔生成方法、裝置及可讀存儲介質。本發明接口文檔生成方法，包括：獲取第一目標服務的數據包，數據包包括第一目標服務的所有接口對應的類文件，一個類文件中包括至少一個接口，解析各類文件，以獲得各類文件中包括的至少一個接口的接口代碼，對各類文件中包括的接口代碼提取接口類信息，以根據接口類信息生成第一目標服務的各接口對應的第一接口文檔。因此，無需人工手動編寫接口文檔，從而可以實現自動生成接口文檔，省時省力，并且避免人工手動編寫接口文檔時容易出錯的問題。

技術領域

本發明涉及計算機技術領域，特別是涉及一種接口文檔生成方法、裝置及可讀存儲介質。

背景技術

在服務的開發過程中，通常需要對服務對應的代碼進行測試，進行代碼測試時需要依據接口文檔對服務對應的代碼進行測試。

目前主要是由開發人員根據編寫服務對應的代碼時所應用到的類名、方法名、服務名等信息編寫接口文檔。由于代碼中涉及的接口可能為多個，在接口存在多個的情況下，就需要針對每個接口都要編寫一個對應的接口文檔，因此，人工手動編寫接口文檔造成人力成本高、耗時長、效率低且容易出錯的問題。

發明內容

本發明實施例提供一種接口文檔生成方法、裝置及可讀存儲介質，以解決目前人工手動編寫接口文檔造成人力成本高、耗時長、效率低且容易出錯的問題。

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

獲取第一目標服務的數據包，其中，所述數據包包括所述第一目標服務的所有接口對應的類文件，一個所述類文件中包括至少一個所述接口；

解析各所述類文件，以獲得各所述類文件中包括的所述至少一個所述接口的接口代碼；

對各所述類文件中包括的接口代碼提取接口類信息，以根據所述接口類信息生成所述第一目標服務的各所述接口對應的第一接口文檔。

本發明實施例的第二方面，提供了一種接口文檔生成裝置，設置于服務器，包括：

第一獲取模塊，用于獲取第一目標服務的數據包，其中，所述數據包包括所述第一目標服務的所有接口對應的類文件，一個所述類文件中包括至少一個所述接口；

解析模塊，用于解析各所述類文件，以獲得各所述類文件中包括所述至少一個所述接口的的接口代碼；

生成模塊，用于對各所述類文件中包括的接口代碼提取接口類信息，以根據所述接口類信息生成所述第一目標服務的各所述接口對應的第一接口文檔。

本發明實施例的第三方面，提供了一種計算機可讀存儲介質，所述計算機可讀存儲介質上存儲計算機程序，所述計算機程序被處理器執行時實現上述所述的接口文檔生成方法的步驟。

本發明的第四方面，提供了一種接口文檔生成裝置，包括處理器、存儲器及存儲在所述存儲器上并可在所述處理器上運行的計算機程序，所述計算機程序被所述處理器執行時實現上述所述的接口文檔生成方法的步驟。

針對在先技術，本發明具備如下優點：

本發明實施例提供的接口文檔生成方法，通過獲取第一目標服務的數據包，數據包包括第一目標服務的所有接口對應的類文件，一個類文件中包括至少一個接口，解析各類文件，以獲得各類文件中包括的所述至少一個所述接口的接口代碼，對各類文件中包括的接口代碼提取接口類信息，以根據所述接口類信息生成第一目標服務的各接口對應的第一接口文檔。因此，無需人工手動編寫接口文檔，從而可以實現自動生成接口文檔，省時省力，并且避免人工手動編寫接口文檔時容易出錯的問題。

上述說明僅是本發明技術方案的概述，為了能夠更清楚了解本發明的技術手段，而可依照說明書的內容予以實施，并且為了讓本發明的上述和其它目的、特征和優點能夠更明顯易懂，以下特舉本發明的具體實施方式。

附圖說明