[發明專利]接口文檔的生成方法、裝置和終端設備

在審

• 申請號: 202011535639.1
• 申請日: 2020-12-22
• 公開（公告）號: CN112650533A
• 公開（公告）日: 2021-04-13
• 發明（設計）人: 李宗波;張卓韜;楊永幫;鄔秋元;陳曉丹;張濤
• 申請（專利權）人: 深圳前海微眾銀行股份有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 北京同立鈞成知識產權代理有限公司 11205
• 代理人: 張娜;劉芳

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

接收用于生成接口文檔的生成請求；

根據所述生成請求，確定目標程序代碼；

根據所述目標程序代碼，分別確定請求字段和返回字段；

通過Java反射機制，分別獲取所述請求字段和所述返回字段各自對應的字段名稱和字段類型；

根據所述請求字段和所述返回字段各自對應的字段名稱和字段類型，生成所述目標程序代碼對應的接口文檔。

2.根據權利要求1所述的方法，其特征在于，所述根據所述請求字段和所述返回字段各自對應的字段名稱和字段類型，生成所述目標程序代碼對應的接口文檔，包括：

針對所述請求字段和所述返回字段中的任一字段，判斷所述字段的字段類型是否為普通數據類型，若所述字段的字段類型不為普通數據類型，則根據所述字段的字段類型，確定所述字段中包括的子字段，并獲取所述子字段對應的字段名稱和字段類型，將所述子字段確定為新的字段，并重復執行此步驟，直至所述字段的字段類型為普通數據類型；

根據所述字段的字段名稱和字段類型，以及所述字段對應的子字段的字段名稱和字段類型，生成所述目標程序代碼對應的接口文檔。

3.根據權利要求2所述的方法，其特征在于，所述根據所述字段的字段名稱和字段類型，以及所述字段對應的子字段的字段名稱和字段類型，生成所述目標程序代碼對應的接口文檔，包括：

獲取與所述目標程序代碼對應的預設模板；

確定所有字段以及所有子字段之間的層級關系；

將所述字段的字段名稱和字段類型，以及所述字段對應的子字段的字段名稱和字段類型，按照所述層級關系，導入所述預設模板中，生成所述接口文檔。

4.根據權利要求1-3任一項所述的方法，其特征在于，根據所述目標程序代碼，確定請求字段，包括：

獲取所述目標程序代碼中多個類；

針對每個類，若所述類對應的代碼注解中包括第一標識符標識的注解信息，且根據所述第一標識符標識的注解信息確定所述類為請求類，則將所述請求類中的字段確定為所述請求字段。

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

若所述多個類中每個類對應的代碼注解中均不包括所述第一標識符標識的注解信息，則判斷各所述類對應的代碼注解中是否包括預設方法；

若所述多個類中存在第一類對應的代碼注解中包括預設方法，則獲取所述預設方法入參中的第二標識符標識的注解信息；

將所述第二標識符標識的注解信息中的字段，確定為所述請求字段。

6.根據權利要求1-3任一項所述的方法，其特征在于，根據所述目標程序代碼，確定返回字段，包括：

獲取所述目標程序代碼中多個類；

針對每個類，判斷所述類對應的代碼注解中是否包括第三標識符標識的注解信息；

若所述類對應的代碼注解中包括第三標識符標識的注解信息，則判斷所述第三標識符標識的注解信息中是否存在預設類；

若存在所述預設類，則將所述預設類中的字段確定為所述返回字段。

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

若所有所述第三標識符標識的注解信息中均不存在所述預設類，則根據預設規則，對所有類的類名進行匹配；

若匹配成功，則將匹配成功的類中的字段確定為所述返回字段；

若匹配失敗，則獲取所述所有類中具有第一標識符標識的注解信息的第二類，根據所述第一標識符標識的注解信息確定所述第二類中的請求類，并獲取所述請求類對應的接口標識，根據所述第一標識符標識的注解信息確定所述第二類中的非請求類，并將所述非請求類對應的接口標識與所述請求類對應的接口標識相同的非請求類中的字段確定為所述返回字段。

8.根據權利要求1-3任一項所述的方法，其特征在于，所述方法還包括：

根據所述目標程序代碼中多個類所對應的代碼注解，獲取所述目標程序代碼對應的接口信息，所述接口信息包括接口標識、接口名稱和接口的描述信息中的至少一種；

將所述接口信息添加在所述接口文檔中。