[發(fā)明專利]基于Spring和Maven的接口文檔自動(dòng)生成方法和裝置

在審

• 申請(qǐng)?zhí)枺?/td>: 202210974969.3
• 申請(qǐng)日: 2022-08-15
• 公開（公告）號(hào): CN115309447A
• 公開（公告）日: 2022-11-08
• 發(fā)明（設(shè)計(jì)）人: 陳子宏
• 申請(qǐng)（專利權(quán)）人: 中國銀行股份有限公司
• 主分類號(hào): G06F8/72
• 分類號(hào): G06F8/72;G06F8/73
• 代理公司: 北京三友知識(shí)產(chǎn)權(quán)代理有限公司 11127
• 代理人: 王天堯;薛平

本發(fā)明提供了一種基于Spring和Maven的接口文檔自動(dòng)生成方法和裝置，涉及計(jì)算機(jī)軟件開發(fā)技術(shù)領(lǐng)域，可用于金融領(lǐng)域，方法包括：通過執(zhí)行項(xiàng)目工程的Maven打包命令觸發(fā)接口信息采集動(dòng)作；采集所述項(xiàng)目工程基于Spring自定義注解形式所標(biāo)注的接口信息；解析所述接口信息并依據(jù)接口文檔模板生成本地接口文件。本申請(qǐng)通過在項(xiàng)目工程編碼過程中利用Spring自定義注解加入接口信息，并在項(xiàng)目進(jìn)行Maven打包過程中收集接口信息，以自動(dòng)生成接口文件，做到編碼與接口文件時(shí)刻保持一致，避免了項(xiàng)目在開發(fā)過程中和使用過程中不斷的改動(dòng)而導(dǎo)致接口文件更新被忽略，從而使得接口文件的維護(hù)成本大為降低。

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

本發(fā)明涉及計(jì)算機(jī)軟件開發(fā)技術(shù)領(lǐng)域，可用于金融領(lǐng)域，尤其涉及一種基于Spring和Maven的接口文檔自動(dòng)生成方法和裝置。

背景技術(shù)

在軟件開發(fā)以及軟件正式投入使用的過程中，經(jīng)常都會(huì)涉及到接口的變更，比如，新增接口、接口字段修改等等，此時(shí)接口文檔就需要同步做出更新，這項(xiàng)工作往往得付出大量的時(shí)間、人力成本，而且經(jīng)常會(huì)因?yàn)槟硞€(gè)產(chǎn)品接口字段的修改未能及時(shí)傳達(dá)至各個(gè)產(chǎn)品而導(dǎo)致任務(wù)的阻塞，或者因?yàn)楸井a(chǎn)品接口文檔維護(hù)不力而導(dǎo)致工作的交接與繼承產(chǎn)生問題。

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

有鑒于此，本發(fā)明提供一種基于Spring和Maven的接口文檔自動(dòng)生成方法和裝置，以解決上述提及的至少一個(gè)問題。

為了實(shí)現(xiàn)上述目的，本發(fā)明采用以下方案：

根據(jù)本發(fā)明的第一方面，提供一種基于Spring和Maven的接口文檔自動(dòng)生成方法，所述方法包括：通過執(zhí)行項(xiàng)目工程的Maven打包命令觸發(fā)接口信息采集動(dòng)作；采集所述項(xiàng)目工程基于Spring自定義注解形式所標(biāo)注的接口信息；解析所述接口信息并依據(jù)接口文檔模板生成本地接口文件。

根據(jù)本發(fā)明的第二方面，提供一種基于Spring和Maven的接口文檔自動(dòng)生成裝置，所述裝置包括：采集觸發(fā)單元，用于通過執(zhí)行項(xiàng)目工程的Maven打包命令觸發(fā)接口信息采集動(dòng)作；接口信息采集單元，用于采集所述項(xiàng)目工程基于Spring自定義注解形式所標(biāo)注的接口信息；接口文件生成單元，用于解析所述接口信息并依據(jù)接口文檔模板生成本地接口文件。

根據(jù)本發(fā)明的第三方面，提供一種電子設(shè)備，包括存儲(chǔ)器、處理器以及存儲(chǔ)在所述存儲(chǔ)器上并可在所述處理器上運(yùn)行的計(jì)算機(jī)程序，處理器執(zhí)行所述計(jì)算機(jī)程序時(shí)實(shí)現(xiàn)上述方法的步驟。

根據(jù)本發(fā)明的第四方面，提供一種計(jì)算機(jī)可讀存儲(chǔ)介質(zhì)，其上存儲(chǔ)有計(jì)算機(jī)程序，所述計(jì)算機(jī)程序被處理器執(zhí)行時(shí)實(shí)現(xiàn)上述方法的步驟。

根據(jù)本發(fā)明的第五方面，提供一種計(jì)算機(jī)程序產(chǎn)品，包括計(jì)算機(jī)程序/指令，其所述計(jì)算機(jī)程序/指令被處理器執(zhí)行時(shí)實(shí)現(xiàn)上述方法的步驟。

由上述技術(shù)方案可知，本申請(qǐng)通過在項(xiàng)目工程編碼過程中利用Spring自定義注解加入接口信息，并在項(xiàng)目進(jìn)行Maven打包過程中收集接口信息，以自動(dòng)生成接口文件，做到編碼與接口文件時(shí)刻保持一致，避免了項(xiàng)目在開發(fā)過程中和使用過程中不斷的改動(dòng)而導(dǎo)致接口文件更新被忽略，從而使得接口文件的維護(hù)成本大為降低。

附圖說明

為了更清楚地說明本發(fā)明實(shí)施例或現(xiàn)有技術(shù)中的技術(shù)方案，下面將對(duì)實(shí)施例或現(xiàn)有技術(shù)描述中所需要使用的附圖作簡單地介紹，顯而易見地，下面描述中的附圖僅僅是本發(fā)明的一些實(shí)施例，對(duì)于本領(lǐng)域普通技術(shù)人員來講，在不付出創(chuàng)造性勞動(dòng)的前提下，還可以根據(jù)這些附圖獲得其他的附圖。在附圖中：

圖1是本申請(qǐng)實(shí)施例提供的一種基于Spring和Maven的接口文檔自動(dòng)生成方法的流程示意圖；

圖2是本申請(qǐng)另一實(shí)施例提供的一種基于Spring和Maven的接口文檔自動(dòng)生成方法；

圖3是本申請(qǐng)本實(shí)施例提供的一種基于Spring和Maven的接口文檔自動(dòng)生成方法中數(shù)據(jù)流向的示意圖；