本申請(qǐng)涉及計(jì)算機(jī)及通信，具體而言，涉及一種接口文檔生成方法及相關(guān)設(shè)備。

背景技術(shù)：

1、在政企瀏覽器服務(wù)端場(chǎng)景中，本身就存在多個(gè)接口。又因?yàn)轫?xiàng)目分支的定制，就存在更多的定制分支下的接口。

2、由于接口數(shù)量過(guò)多，而前后端開(kāi)發(fā)中經(jīng)常需要根據(jù)代碼來(lái)進(jìn)行溝通，故現(xiàn)在一般會(huì)通過(guò)接口文檔表現(xiàn)代碼特征。但是隨著時(shí)間的推移，依靠人力維護(hù)的接口文檔經(jīng)常會(huì)出現(xiàn)和對(duì)應(yīng)代碼不同步的情況，影響了開(kāi)發(fā)進(jìn)度。

技術(shù)實(shí)現(xiàn)思路

1、本申請(qǐng)的實(shí)施例提供了一種接口文檔生成方法及相關(guān)設(shè)備，進(jìn)而至少在一定程度上可以克服現(xiàn)有技術(shù)的接口文檔經(jīng)常會(huì)出現(xiàn)和對(duì)應(yīng)代碼不同步的問(wèn)題。

2、本申請(qǐng)的其他特性和優(yōu)點(diǎn)將通過(guò)下面的詳細(xì)描述變得顯然，或部分地通過(guò)本申請(qǐng)的實(shí)踐而習(xí)得。

3、根據(jù)本申請(qǐng)實(shí)施例的一個(gè)方面，提供了一種接口文檔生成方法，所述接口文檔生成方法包括：響應(yīng)于接口代碼編寫(xiě)的完成，獲取所述接口代碼對(duì)應(yīng)的注釋信息以及對(duì)應(yīng)接口的接口信息；根據(jù)所述注釋信息，生成規(guī)范文檔；將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔。

4、在本申請(qǐng)的一些實(shí)施例中，所述將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔，具體包括：根據(jù)所述接口信息，遍歷所述規(guī)范文檔中的所有元素，得到多個(gè)接口列表；根據(jù)各所述接口列表重新編排文檔，生成對(duì)應(yīng)的接口文檔。

5、在本申請(qǐng)的一些實(shí)施例中，所述接口信息包括接口標(biāo)簽，所述遍歷所述規(guī)范文檔中的所有元素，得到多個(gè)接口列表包括：遍歷所述規(guī)范文檔中的所有元素，得到接口總列表；根據(jù)所述接口標(biāo)簽拆分所述接口總列表，得到多個(gè)接口列表。

6、在本申請(qǐng)的一些實(shí)施例中，所述根據(jù)各所述接口列表重新編排文檔，生成對(duì)應(yīng)的接口文檔，具體包括：根據(jù)各所述接口列表，解析所述接口標(biāo)簽；根據(jù)所述解析結(jié)果，重新編排文檔，生成對(duì)應(yīng)的接口文檔。

7、在本申請(qǐng)的一些實(shí)施例中，所述根據(jù)所述注釋信息，生成規(guī)范文檔，具體包括：根據(jù)所述注釋信息，得到規(guī)范接口定義；將所述規(guī)范接口定義填充至文檔模板中，得到規(guī)范文檔。

8、在本申請(qǐng)的一些實(shí)施例中，所述根據(jù)所述注釋信息，得到規(guī)范接口定義，具體包括：根據(jù)接口信息，獲取對(duì)應(yīng)的規(guī)范化模板；通過(guò)所述規(guī)范化模板對(duì)所述注釋信息進(jìn)行規(guī)范化處理，得到規(guī)范接口定義。

9、在本申請(qǐng)的一些實(shí)施例中，所述根據(jù)所述注釋信息，得到規(guī)范接口定義，具體包括：將所述注釋信息輸入接口規(guī)范模型，所述接口規(guī)范模型輸出對(duì)應(yīng)的規(guī)范接口定義。

10、在本申請(qǐng)的一些實(shí)施例中，所述接口文檔生成方法還包括：獲取注釋信息樣本集，所述注釋信息樣本集包含多個(gè)注釋信息樣本，每個(gè)所述注釋信息樣本均標(biāo)注又對(duì)應(yīng)的規(guī)范接口定義；將所述注釋信息樣本集中的注釋信息樣本逐個(gè)輸入所述接口規(guī)范模型，得到所述接口規(guī)范模型輸出的規(guī)范接口定義；根據(jù)所述輸出的規(guī)范接口定義和輸出的規(guī)范接口定義，進(jìn)行參數(shù)更新，直至滿足預(yù)定條件，停止訓(xùn)練，得到訓(xùn)練好的接口規(guī)范模型。

11、在本申請(qǐng)的一些實(shí)施例中，在所述將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔之后，所述接口文檔生成方法還包括：將所述接口文檔逐一進(jìn)行可視化處理，以向開(kāi)發(fā)人員展示。

12、根據(jù)本申請(qǐng)實(shí)施例的一個(gè)方面，提供了一種接口文檔生成裝置，所述接口文檔生成裝置包括：信息獲取模塊，用于響應(yīng)于接口代碼編寫(xiě)的完成，獲取所述接口代碼對(duì)應(yīng)的注釋信息以及對(duì)應(yīng)接口的接口信息；文檔生成模塊，用于根據(jù)所述注釋信息，生成規(guī)范文檔；文檔拆分模塊，用于將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔。

13、在本申請(qǐng)的一些實(shí)施例中，所述文檔拆分模塊具體包括：文檔遍歷子模塊，用于根據(jù)所述接口信息，遍歷所述規(guī)范文檔中的所有元素，得到多個(gè)接口列表；文檔編排子模塊，用于根據(jù)各所述接口列表重新編排文檔，生成對(duì)應(yīng)的接口文檔。

14、在本申請(qǐng)的一些實(shí)施例中，所述接口信息包括接口標(biāo)簽，所述文檔遍歷子模塊包括：文檔遍歷單元，用于遍歷所述規(guī)范文檔中的所有元素，得到接口總列表；列表拆分單元，用于根據(jù)所述接口標(biāo)簽拆分所述接口總列表，得到多個(gè)接口列表。

15、在本申請(qǐng)的一些實(shí)施例中，所述文檔編排子模塊具體包括：標(biāo)簽解析單元，用于根據(jù)各所述接口列表，解析所述接口標(biāo)簽；文檔編排單元，用于根據(jù)所述解析結(jié)果，重新編排文檔，生成對(duì)應(yīng)的接口文檔。

16、在本申請(qǐng)的一些實(shí)施例中，所述文檔生成模塊具體包括：規(guī)范定義子模塊，用于根據(jù)所述注釋信息，得到規(guī)范接口定義；模板填充子模塊，用于將所述規(guī)范接口定義填充至文檔模板中，得到規(guī)范文檔。

17、在本申請(qǐng)的一些實(shí)施例中，所述規(guī)范定義子模塊具體包括：模板獲取單元，用于根據(jù)接口信息，獲取對(duì)應(yīng)的規(guī)范化模板；規(guī)范處理單元，用于通過(guò)所述規(guī)范化模板對(duì)所述注釋信息進(jìn)行規(guī)范化處理，得到規(guī)范接口定義。

18、在本申請(qǐng)的一些實(shí)施例中，所述規(guī)范定義子模塊具體包括：模型輸入單元，用于將所述注釋信息輸入接口規(guī)范模型，所述接口規(guī)范模型輸出對(duì)應(yīng)的規(guī)范接口定義。

19、在本申請(qǐng)的一些實(shí)施例中，所述接口文檔生成裝置還包括：樣本獲取模塊，用于獲取注釋信息樣本集，所述注釋信息樣本集包含多個(gè)注釋信息樣本，每個(gè)所述注釋信息樣本均標(biāo)注又對(duì)應(yīng)的規(guī)范接口定義；樣本輸入模塊，用于將所述注釋信息樣本集中的注釋信息樣本逐個(gè)輸入所述接口規(guī)范模型，得到所述接口規(guī)范模型輸出的規(guī)范接口定義；參數(shù)更新模塊，用于根據(jù)所述輸出的規(guī)范接口定義和輸出的規(guī)范接口定義，進(jìn)行參數(shù)更新，直至滿足預(yù)定條件，停止訓(xùn)練，得到訓(xùn)練好的接口規(guī)范模型。

20、在本申請(qǐng)的一些實(shí)施例中，所述接口文檔生成裝置還包括：可視化模塊，用于將所述接口文檔逐一進(jìn)行可視化處理，以向開(kāi)發(fā)人員展示。

21、根據(jù)本申請(qǐng)實(shí)施例的一個(gè)方面，提供了一種計(jì)算機(jī)可讀介質(zhì)，其上存儲(chǔ)有計(jì)算機(jī)程序，所述計(jì)算機(jī)程序被處理器執(zhí)行時(shí)實(shí)現(xiàn)如上述實(shí)施例中所述的接口文檔生成方法。

22、根據(jù)本申請(qǐng)實(shí)施例的一個(gè)方面，提供了一種電子設(shè)備，包括：一個(gè)或多個(gè)處理器；存儲(chǔ)裝置，用于存儲(chǔ)一個(gè)或多個(gè)程序，當(dāng)所述一個(gè)或多個(gè)程序被所述一個(gè)或多個(gè)處理器執(zhí)行時(shí)，使得所述一個(gè)或多個(gè)處理器實(shí)現(xiàn)如上述實(shí)施例中所述的接口文檔生成方法。

23、在本申請(qǐng)的一些實(shí)施例所提供的技術(shù)方案中，通過(guò)在代碼編寫(xiě)完成后自動(dòng)獲取對(duì)應(yīng)的注釋信息和接口信息，將注釋信息整理生成對(duì)應(yīng)的規(guī)范文檔，然后將規(guī)范文檔根據(jù)接口信息進(jìn)行拆分，得到對(duì)應(yīng)的接口文檔。該接口文檔是在代碼編寫(xiě)完成后即自動(dòng)生成的，開(kāi)發(fā)人員只要編寫(xiě)好代碼和注釋信息，就可以根據(jù)代碼和注釋信息自動(dòng)生成接口文檔，實(shí)現(xiàn)了代碼和文檔的強(qiáng)綁定，避免了現(xiàn)有技術(shù)的接口文檔經(jīng)常會(huì)出現(xiàn)和對(duì)應(yīng)代碼不同步的情況，減少了接口維護(hù)的時(shí)間和成本，提升了開(kāi)發(fā)效率。

24、應(yīng)當(dāng)理解的是，以上的一般描述和后文的細(xì)節(jié)描述僅是示例性和解釋性的，并不能限制本申請(qǐng)。

技術(shù)特征：

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

2.如權(quán)利要求1所述的接口文檔生成方法，其特征在于，所述將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔，具體包括：

3.如權(quán)利要求2所述的接口文檔生成方法，其特征在于，所述接口信息包括接口標(biāo)簽，所述遍歷所述規(guī)范文檔中的所有元素，得到多個(gè)接口列表包括：

4.如權(quán)利要求3所述的接口文檔生成方法，其特征在于，所述根據(jù)各所述接口列表重新編排文檔，生成對(duì)應(yīng)的接口文檔，具體包括：

5.如權(quán)利要求1所述的接口文檔生成方法，其特征在于，所述根據(jù)所述注釋信息，生成規(guī)范文檔，具體包括：

6.如權(quán)利要求5所述的接口文檔生成方法，其特征在于，所述根據(jù)所述注釋信息，得到規(guī)范接口定義，具體包括：

7.如權(quán)利要求6所述的接口文檔生成方法，其特征在于，所述接口文檔生成方法還包括：

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

9.一種計(jì)算機(jī)可讀介質(zhì)，其上存儲(chǔ)有計(jì)算機(jī)程序，其特征在于，所述計(jì)算機(jī)程序被處理器執(zhí)行時(shí)實(shí)現(xiàn)如權(quán)利要求1至7中任一項(xiàng)所述的接口文檔生成方法。

10.一種電子設(shè)備，其特征在于，包括：

技術(shù)總結(jié)
本申請(qǐng)的實(shí)施例提供了一種接口文檔生成方法及相關(guān)設(shè)備。所述接口文檔生成方法包括：響應(yīng)于接口代碼編寫(xiě)的完成，獲取所述接口代碼對(duì)應(yīng)的注釋信息以及對(duì)應(yīng)接口的接口信息；根據(jù)所述注釋信息，生成規(guī)范文檔；將所述規(guī)范文檔根據(jù)所述接口信息進(jìn)行拆分，生成對(duì)應(yīng)的接口文檔。本申請(qǐng)實(shí)施例的技術(shù)方案中接口文檔是在代碼編寫(xiě)完成后即自動(dòng)生成的，開(kāi)發(fā)人員只要編寫(xiě)好代碼和注釋信息，就可以根據(jù)代碼和注釋信息自動(dòng)生成接口文檔，實(shí)現(xiàn)了代碼和文檔的強(qiáng)綁定，避免了現(xiàn)有技術(shù)的接口文檔經(jīng)常會(huì)出現(xiàn)和對(duì)應(yīng)代碼不同步的情況，減少了接口維護(hù)的時(shí)間和成本，提升了開(kāi)發(fā)效率。

技術(shù)研發(fā)人員：趙磊磊,楊麗香,郭建強(qiáng),吳滿
受保護(hù)的技術(shù)使用者：三六零數(shù)字安全科技集團(tuán)有限公司
技術(shù)研發(fā)日：
技術(shù)公布日：2025/5/15