[發明專利]一種接口文檔生成方法、裝置、設備及存儲介質

在審

• 申請號: 202011363228.9
• 申請日: 2020-11-27
• 公開（公告）號: CN112416430A
• 公開（公告）日: 2021-02-26
• 發明（設計）人: 凌利虎;吳迪;虞佳祺;邢婷;王鋆昌;汪斌
• 申請（專利權）人: 億企贏網絡科技有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 北京集佳知識產權代理有限公司 11227
• 代理人: 劉翠香

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

在檢測到有代碼文件提交時，在提交的代碼文件中確定目標Java文件；

基于所述目標Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數據信息；

根據所述接口元數據信息生成接口文檔。

2.根據權利要求1所述的接口文檔生成方法，其特征在于，所述基于所述目標Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數據信息，包括：

對所述目標Java文件進行遍歷，確定接口類；

對每個接口類中的方法進行遍歷，基于SpringMVC注解，確定帶有動作注解的接口方法；

針對每個接口方法，根據該接口方法的動作注解，確定該接口方法對應接口的接口動作和接口路徑；根據該接口方法的Javadoc注釋，確定該接口方法對應接口的接口名稱、接口描述及該接口方法的參數描述、返回值描述；

對每個接口方法對應接口的接口動作、接口路徑、接口名稱、接口描述及每個接口方法的參數描述、返回值描述進行抽象轉換處理，獲得接口元數據信息。

3.根據權利要求2所述的接口文檔生成方法，其特征在于，所述對所述目標Java文件進行遍歷，確定接口類，包括：

對所述目標Java文件進行遍歷，將標記有@RestController或者@RequestMapping注解的類確定為接口類。

4.根據權利要求2所述的接口文檔生成方法，其特征在于，所述動作注解包括@GetMapping、@PostMapping、@PatchMapping、@PutMapping和@DeleteMapping中的至少一個。

5.根據權利要求2所述的接口文檔生成方法，其特征在于，針對每個接口方法，通過以下步驟確定該接口方法對應接口的接口路徑：

根據該接口方法的動作注解中的路徑屬性，確定該接口方法對應接口的接口路徑。

6.根據權利要求1至5之中任一項所述的接口文檔生成方法，其特征在于，所述根據所述接口元數據信息生成接口文檔，包括：

根據所述接口元數據信息，更新數據庫中記錄的接口元數據；

根據更新后的所述數據庫中記錄的接口元數據，生成接口文檔。

7.根據權利要求6所述的接口文檔生成方法，其特征在于，所述根據所述接口元數據信息，更新數據庫中記錄的接口元數據，包括：

針對所述接口元數據信息中的每個接口，如果數據庫中記錄的該接口的元數據與所述接口元數據信息中該接口的元數據不同，則使用所述接口元數據信息中該接口的元數據更新所述數據庫中記錄的該接口的元數據；如果所述數據庫中未記錄有該接口的元數據，則在所述數據庫中增加記錄所述接口元數據信息中該接口的元數據；

針對所述數據庫中記錄的變更接口類的每個接口，如果所述接口元數據信息中不存在該接口的元數據，則在所述數據庫中刪除該接口的元數據。

8.一種接口文檔生成裝置，其特征在于，包括：

Java文件確定模塊，用于在檢測到有代碼文件提交時，在提交的代碼文件中確定目標Java文件；

接口元數據獲得模塊，用于基于所述目標Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數據信息；

接口文檔生成模塊，用于根據所述接口元數據信息生成接口文檔。

9.一種接口文檔生成設備，其特征在于，包括：

存儲器，用于存儲計算機程序；

處理器，用于執行所述計算機程序時實現如權利要求1至7任一項所述接口文檔生成方法的步驟。

10.一種計算機可讀存儲介質，其特征在于，所述計算機可讀存儲介質上存儲有計算機程序，所述計算機程序被處理器執行時實現如權利要求1至7任一項所述接口文檔生成方法的步驟。