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

在審

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

1.一種接口文檔生成方法，其特征在于，執行于服務器，包括：

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

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

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

2.根據權利要求1所述的方法，其特征在于，所述接口類信息包括類名、方法名、第一目標服務標識、所述方法名對應的方法的輸入參數、所述方法的返回參數、第一版本標識、以及與所述第一目標服務標識和所述第一版本標識都對應的端口標識和地址標識，第一版本標識為所述第一目標服務的第一版本的標識。

3.根據權利要求2所述的方法，其特征在于，在所述對各所述類文件中包括的所述接口代碼提取接口類信息，以根據所述接口類信息生成所述第一目標服務的各所述接口對應的第一接口文檔之后，還包括：

將與所述第一目標服務標識、所述第一版本標識、以及所述接口的接口標識都關聯的所述第一接口文檔存儲在數據庫中。

4.根據權利要求3所述的方法，其特征在于，在所述將與所述第一目標服務標識、所述第一版本標識、以及所述接口的接口標識都關聯的所述第一接口文檔存儲在數據庫中之后，還包括：

每間隔預設時間對代碼服務器上存儲的所述第一目標服務的數據包進行掃描，以根據所述數據包對應的時間信息，判斷所述數據包是否發生更新；

在確定所述數據包發生更新的情況下，從所述代碼服務器獲取更新后的數據包；

對所述更新后的數據包進行分析，以確定目標接口，其中，所述目標接口包括所述更新后的數據包中的新增類文件對應的接口和/或所述更新后的數據包中發生變更的原類文件對應的接口；

對所述目標接口的接口代碼提取接口類信息，以根據目標接口的接口代碼對應的接口類信息生成與所述目標接口對應的第二接口文檔；

將與所述第一目標服務標識、所述第一版本標識、以及所述目標接口的接口標識都關聯的所述第二接口文檔存儲在所述數據庫中。

5.根據權利要求1-4任一所述的方法，其特征在于，在所述獲取第一目標服務的數據包之前，還包括：

接收終端發送的請求消息，其中，所述請求消息中包括所述第一目標服務的第一目標服務標識、所述第一目標服務的所述第一版本標識、以及與所述第一目標服務標識和所述第一版本標識都對應的存儲地址；

所述獲取第一目標服務的數據包，包括：

從代碼服務器的所述存儲地址，獲取與所述第一目標服務標識和所述第一版本標識都對應的所述第一目標服務的數據包。

6.根據權利要求5所述的方法，其特征在于，還包括：

接收終端發送的頁面請求；

響應于所述頁面請求，從所述數據庫中獲取至少一個服務的服務標識、與所述服務標識對應的版本標識、以及與所述版本標識對應的接口標識；

向所述終端發送獲取的所述服務的服務標識、與所述服務標識對應的版本標識、以及與所述版本標識對應的接口標識，以使所述終端顯示所述服務的服務標識、與所述服務標識對應的版本標識、以及與所述版本標識對應的接口標識。