[發明專利]接口文檔的生成方法及系統

有效

• 申請號: 201810474558.1
• 申請日: 2018-05-17
• 公開（公告）號: CN108762808B
• 公開（公告）日: 2021-06-08
• 發明（設計）人: 李偉榮
• 申請（專利權）人: 李偉榮
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F40/169
• 代理公司: 北京冠和權律師事務所 11399
• 代理人: 朱健;陳國軍

本發明公開了一種接口文檔的生成方法及系統，通過利用Javadoc的doclet技術，從源代碼中解析出服務接口信息；根據解析出的服務接口信息，為每個服務接口生成對應的接口文檔；將生成的所述接口文檔上傳至文檔管理數據庫，以供查詢；具有無需手動編寫配置文件且無需額外引入注解來標記接口、即可自動生成對應的接口文檔的有益效果，提高了系統開發效率；進一步地，由于無需引入額外的注解或者注釋來標記接口，避免了因引入額外注釋來標記接口而對原有系統所造成的侵入性。

技術領域

本發明涉及計算機技術領域，特別涉及一種接口文檔的生成方法及系統。

背景技術

在接口開發過程中，開發人員需要提供完善的接口文檔。接口文檔的手工編寫浪費了開發人員的開發時間，效率低且容易出錯。而現有的自動化生成工具有些也需要手工編寫配置文件，效率提升不夠明顯；另外，有些自動化生成工具需要引入額外的注解來標記接口，這種做法會對原有系統造成一定的侵入性。

發明內容

本發明提供一種接口文檔的生成方法及系統，旨在利用代碼解析技術，無需手動編寫配置文件且無需額外引入注解來標記接口，即可自動生成對應的接口文檔，提高開發效率。

本發明提供了一種接口文檔的生成方法，所述接口文檔的生成方法包括：

利用Javadoc的doclet技術，從源代碼中解析出服務接口信息；

根據解析出的服務接口信息，為每個服務接口生成對應的接口文檔；

將生成的所述接口文檔上傳至文檔管理數據庫，以供查詢。

進一步地，所述利用Javadoc的doclet技術，從源代碼中解析出服務接口信息，包括：

利用Javadoc的doclet技術，不強制對被解析的源代碼添加注釋或者接口標注，識別出源代碼中所使用的服務框架；

基于使用的所述服務框架，解析所述源代碼中的服務接口以及所述服務接口對應的相關參數，得到對應的服務接口信息。

進一步地，所述從源代碼中解析出的服務接口信息包括：所述服務接口對應的注釋以及所述服務接口對應的輸入參數和輸出參數；

根據解析出的所述輸入參數和輸出參數，按照所述服務接口對應的注釋，完善對應的接口文檔；

其中，所述注釋無需被解析的所述源代碼引入對應的類庫。

進一步地，所述將生成的所述接口文檔上傳至文檔管理數據庫，包括：

根據所述服務接口信息，刪除已上傳的相同屬性的接口文檔，保留最新上傳的所述相同屬性對應的接口文檔；

其中，所述相同屬性包括：相同的系統名稱、相同的版本號和相同的接口地址。

進一步地，所述為每個服務接口生成對應的接口文檔，包括：

獲取所述服務接口信息中的所有的返回參數，并確定每個所述返回參數的字符信息；

分別根據所述返回參數的字符信息生成與所述返回參數相應的字符數組Xⁱ，且其中，xⁱ_j為第i個字符數組中的第j個元素值，n_i為第i個返回參數的字符總數，i∈[1，m]，m為返回參數的總數量；

將所述字符數組中前三個元素相同的字符數組歸為一個參數集合，并遍歷確定所述參數集合中字符數組的相同元素以及相同元素個數p，p≥3；

根據p個相同元素的元素值確定所述參數集合的權重系數W^k，并根據參數集合的權重系數W^k確定參數集合排列順序；其中，第k個參數集合的權重系數W^k為：