[發(fā)明專利]一種接口文檔生成方法、裝置、設(shè)備及存儲介質(zhì)

在審

• 申請?zhí)枺?/td>: 202011363228.9
• 申請日: 2020-11-27
• 公開（公告）號: CN112416430A
• 公開（公告）日: 2021-02-26
• 發(fā)明（設(shè)計(jì)）人: 凌利虎;吳迪;虞佳祺;邢婷;王鋆昌;汪斌
• 申請（專利權(quán)）人: 億企贏網(wǎng)絡(luò)科技有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 北京集佳知識產(chǎn)權(quán)代理有限公司 11227
• 代理人: 劉翠香

本申請公開了一種接口文檔生成方法，該方法包括以下步驟：在檢測到有代碼文件提交時(shí)，在提交的代碼文件中確定目標(biāo)Java文件；基于目標(biāo)Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數(shù)據(jù)信息；根據(jù)接口元數(shù)據(jù)信息生成接口文檔。應(yīng)用本申請所提供的技術(shù)方案，自動(dòng)分析Java文件中的Javadoc注釋和SpringMVC注解，得到接口元數(shù)據(jù)信息，不需要開發(fā)人員額外書寫接口信息，減輕了開發(fā)人員的工作壓力，可以及時(shí)修改接口文檔，提高了接口文檔的有效性，保證接口文檔和代碼的一致性，可以避免產(chǎn)生接口文檔暴露到生產(chǎn)環(huán)境的風(fēng)險(xiǎn)。本申請還公開了一種接口文檔生成裝置、設(shè)備及存儲介質(zhì)，具有相應(yīng)技術(shù)效果。

技術(shù)領(lǐng)域

本申請涉及計(jì)算機(jī)應(yīng)用技術(shù)領(lǐng)域，特別是涉及一種接口文檔生成方法、裝置、設(shè)備及存儲介質(zhì)。

背景技術(shù)

在軟件開發(fā)過程中，前后端的交互過程多采用基于RESTful(RepresentationalState Transfer)架構(gòu)的API(Application Programming Interface，應(yīng)用程序接口)作為調(diào)用方式，具有輕量、數(shù)據(jù)描述簡單和低耦合等特點(diǎn)。

在開發(fā)過程中可以是后端開發(fā)人員使用Word或Markdown等文檔方式手工編寫接口文檔，完成后發(fā)送給前端開發(fā)人員進(jìn)行開發(fā)。

還可以在項(xiàng)目代碼中引入Swagger框架來生成、展示接口文檔。Swagger是一個(gè)用于生成、描述和展示RESTful接口的規(guī)范和完整的框架。需要開發(fā)人員額外增加Swagger相關(guān)注解生成接口文檔。每次接口變更都要手動(dòng)修改相應(yīng)代碼后重新部署代碼，并通知相關(guān)人員。

使用第一種方式時(shí)，如果接口較多，則文檔編寫較為繁瑣，且容易出錯(cuò)。隨著開發(fā)的進(jìn)行，存在對文檔的反復(fù)修改、修改不及時(shí)和通知滯后等問題，文檔維護(hù)較難，經(jīng)常出現(xiàn)接口文檔和實(shí)際Java代碼不一致的情況。

使用第二種方式時(shí)，需要開發(fā)人員額外增加大量注解代碼來描述接口功能和說明，增加了對代碼的侵入性，強(qiáng)耦合了代碼和接口文檔，同時(shí)也增加了開發(fā)人員的工作壓力。另外，Swagger也存在把接口文檔暴露到生產(chǎn)環(huán)境的風(fēng)險(xiǎn)。

發(fā)明內(nèi)容

本申請的目的是提供一種接口文檔生成方法、裝置、設(shè)備及存儲介質(zhì)，以及時(shí)自動(dòng)生成接口文檔，解決接口文檔修改不及時(shí)、通知滯后等問題，可以減輕開發(fā)人員工作壓力，避免產(chǎn)生接口文檔暴露到生產(chǎn)環(huán)境的風(fēng)險(xiǎn)。

為解決上述技術(shù)問題，本申請?zhí)峁┤缦录夹g(shù)方案：

一種接口文檔生成方法，包括：

在檢測到有代碼文件提交時(shí)，在提交的代碼文件中確定目標(biāo)Java文件；

基于所述目標(biāo)Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數(shù)據(jù)信息；

根據(jù)所述接口元數(shù)據(jù)信息生成接口文檔。

在本申請的一種具體實(shí)施方式中，所述基于所述目標(biāo)Java文件中的Javadoc注釋和SpringMVC注解，獲得接口元數(shù)據(jù)信息，包括：

對所述目標(biāo)Java文件進(jìn)行遍歷，確定接口類；

對每個(gè)接口類中的方法進(jìn)行遍歷，基于SpringMVC注解，確定帶有動(dòng)作注解的接口方法；

針對每個(gè)接口方法，根據(jù)該接口方法的動(dòng)作注解，確定該接口方法對應(yīng)接口的接口動(dòng)作和接口路徑；根據(jù)該接口方法的Javadoc注釋，確定該接口方法對應(yīng)接口的接口名稱、接口描述及該接口方法的參數(shù)描述、返回值描述；

對每個(gè)接口方法對應(yīng)接口的接口動(dòng)作、接口路徑、接口名稱、接口描述及每個(gè)接口方法的參數(shù)描述、返回值描述進(jìn)行抽象轉(zhuǎn)換處理，獲得接口元數(shù)據(jù)信息。

在本申請的一種具體實(shí)施方式中，所述對所述目標(biāo)Java文件進(jìn)行遍歷，確定接口類，包括：