[發(fā)明專(zhuān)利]接口文檔的集成方法、裝置、服務(wù)器及計(jì)算機(jī)存儲(chǔ)介質(zhì)

在審

• 申請(qǐng)?zhí)枺?/td>: 202011084630.3
• 申請(qǐng)日: 2020-10-12
• 公開(kāi)（公告）號(hào): CN112230891A
• 公開(kāi)（公告）日: 2021-01-15
• 發(fā)明（設(shè)計(jì)）人: 陳偉;劉佳;程勝;陳凱
• 申請(qǐng)（專(zhuān)利權(quán)）人: 中國(guó)民航信息網(wǎng)絡(luò)股份有限公司
• 主分類(lèi)號(hào): G06F8/20
• 分類(lèi)號(hào): G06F8/20;G06F8/38;G06F11/36
• 代理公司: 北京集佳知識(shí)產(chǎn)權(quán)代理有限公司 11227
• 代理人: 李慧引

本申請(qǐng)?zhí)峁┝艘环N接口文檔的集成方法、裝置、服務(wù)器及計(jì)算機(jī)存儲(chǔ)介質(zhì)，該方法包括：當(dāng)網(wǎng)關(guān)服務(wù)啟動(dòng)時(shí)，確定需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)；其中，所述目標(biāo)服務(wù)包括：業(yè)務(wù)服務(wù)和網(wǎng)關(guān)服務(wù)；然后，獲取所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔；最終，對(duì)所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔進(jìn)行集成，得到接口文檔集合。從而在前端開(kāi)發(fā)和測(cè)試人員在需要找到目標(biāo)服務(wù)的接口文檔時(shí)，可以在集成后的接口文檔集合中，查找目標(biāo)服務(wù)的接口文檔，并根據(jù)目標(biāo)服務(wù)的每個(gè)接口上添加的接口對(duì)應(yīng)的說(shuō)明信息進(jìn)行查找。

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

本申請(qǐng)涉及計(jì)算機(jī)技術(shù)領(lǐng)域，特別涉及一種接口文檔的集成方法、裝置、服務(wù)器及計(jì)算機(jī)存儲(chǔ)介質(zhì)。

背景技術(shù)

前后端分離技術(shù)已經(jīng)逐漸成為互聯(lián)網(wǎng)項(xiàng)目的一種標(biāo)準(zhǔn)的開(kāi)發(fā)模式。前后端分離技術(shù)即前端開(kāi)發(fā)不需要部署后端語(yǔ)言環(huán)境，后端開(kāi)發(fā)也不需要前端為其提供任何程序輔助；后端只管展現(xiàn)各種Api接口，供給前端進(jìn)行數(shù)據(jù)的增刪改查，不負(fù)責(zé)生成HTML頁(yè)面；同時(shí)，測(cè)試人員也只需要測(cè)試后端接口即可。

目前，前后端分離技術(shù)通常采用業(yè)界公用通用的方式來(lái)做接口契約開(kāi)發(fā)，它可以動(dòng)態(tài)生成Api接口文檔，做到代碼與接口文檔同源，并提供UI界面進(jìn)行接口查看，在線(xiàn)進(jìn)行接口測(cè)試等，極大降低溝通成本，解放開(kāi)發(fā)人員的維護(hù)更新成本，減少由于信息不對(duì)稱(chēng)造成的前后端矛盾。

但是，隨著系統(tǒng)變得異常龐大以后。單應(yīng)用已無(wú)法支撐海量業(yè)務(wù)。因此，需要按業(yè)務(wù)服務(wù)進(jìn)行拆分，在拆分后。由于一個(gè)應(yīng)用會(huì)劃分為很多個(gè)子應(yīng)用，這就導(dǎo)致前端開(kāi)發(fā)和測(cè)試人員需要到多個(gè)地方去找后端所提供的接口文檔。

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

有鑒于此，本申請(qǐng)?zhí)峁┮环N接口文檔的集成方法、裝置、服務(wù)器及計(jì)算機(jī)存儲(chǔ)介質(zhì)，用于在前端開(kāi)發(fā)和測(cè)試人員在需要找到目標(biāo)服務(wù)的接口文檔時(shí)，可以在集成后的接口文檔集合中，查找目標(biāo)服務(wù)的接口文檔。

本申請(qǐng)第一方面提供了一種接口文檔的集成方法，包括：

當(dāng)網(wǎng)關(guān)服務(wù)啟動(dòng)時(shí)，確定需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)；其中，所述目標(biāo)服務(wù)包括：業(yè)務(wù)服務(wù)和網(wǎng)關(guān)服務(wù)；

獲取所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔；

對(duì)所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔進(jìn)行集成，得到接口文檔集合。

可選的，一個(gè)所述目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔的生成方法，包括：

獲取所述目標(biāo)服務(wù)的文檔支持包；

利用所述文檔支持包中的數(shù)據(jù)，配置所述目標(biāo)服務(wù)的文檔參數(shù)；

為配置文檔參數(shù)后的所述目標(biāo)服務(wù)的每個(gè)接口，添加所述接口對(duì)應(yīng)的說(shuō)明信息，得到所述目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔。

可選的，所述對(duì)所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔進(jìn)行集成，得到接口文檔集合，包括：

將每一個(gè)所述目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔的路徑信息進(jìn)行集合，得到最終的文檔對(duì)象；

利用所述最終的文檔對(duì)象覆蓋所述網(wǎng)關(guān)的文檔對(duì)象，得到所述接口文檔集合。

可選的，所述對(duì)所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔進(jìn)行集成，得到接口文檔集合之后，還包括：

根據(jù)所述接口文檔集合，生成UI界面。

可選的，所述文檔支持包提供gradle版本或maven版本的集成支持。

本申請(qǐng)第二方面提供了一種接口文檔的集成裝置，包括：

確定單元，用于當(dāng)網(wǎng)關(guān)服務(wù)啟動(dòng)時(shí)，確定需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)；其中，所述目標(biāo)服務(wù)包括：業(yè)務(wù)服務(wù)和網(wǎng)關(guān)服務(wù)；

第一獲取單元，用于獲取所述需要網(wǎng)關(guān)代理的每一個(gè)目標(biāo)服務(wù)對(duì)應(yīng)的接口文檔；