【技術(shù)實(shí)現(xiàn)步驟摘要】
本專利技術(shù)屬于計(jì)算機(jī)，尤其是涉及一種基于openapi規(guī)范的集中式文檔采集管理方法。
技術(shù)介紹
1、openapi全稱是openapi?specification(openapi規(guī)范，簡(jiǎn)稱osa)，它使用規(guī)定的格式來(lái)描述http?restful?api的定義，以此來(lái)規(guī)范restful服務(wù)開(kāi)發(fā)過(guò)程。使用json或yaml來(lái)描述一個(gè)標(biāo)準(zhǔn)的、與編程語(yǔ)言無(wú)關(guān)的http?api接口。openapi規(guī)范最初基于smartbearsoftware在2015年捐贈(zèng)的swagger規(guī)范演變而來(lái)，目前最新的版本是v3.x版本。簡(jiǎn)單來(lái)說(shuō)，openapi就是用來(lái)定義http接口文檔的一種規(guī)范，大家都按照同一套規(guī)范來(lái)編寫接口文檔，能夠極大的減少溝通成本。
2、通過(guò)openapi規(guī)范文檔對(duì)一個(gè)http?restful?api接口進(jìn)行描述，一般有2種方式，一種是根據(jù)接口的功能和規(guī)格，手工編寫openapi規(guī)范文檔。另一種是通過(guò)代碼即文檔的方式，通過(guò)一些swagger提供的工具，為工程中的restfulapi代碼自動(dòng)生成openapi文檔。
3、目前，很多java框架都可以通過(guò)集成swagger工具(https://swagger.io/)的方式，將所開(kāi)發(fā)業(yè)務(wù)代碼的restful接口通過(guò)openapi規(guī)范的方式對(duì)外進(jìn)行暴露，這樣，其他的三方使用人員可以通過(guò)查看工程所暴露的openapi接口文檔，就能快速了解到如何使用我們工程中的業(yè)務(wù)api接口(例如查看接口描述，出入?yún)ⅲ{(diào)用方式等)。
4、例如，典型的使用方式是：通過(guò)spri
5、通過(guò)java框架+swagger工具為業(yè)務(wù)restful?api代碼自動(dòng)生成openapi規(guī)范文檔的方式可以很好的解決單個(gè)工程openapi文檔自動(dòng)生成的問(wèn)題，但是在實(shí)際的環(huán)境中，會(huì)存在以下幾個(gè)問(wèn)題：
6、(1)在實(shí)際生產(chǎn)環(huán)境中，應(yīng)用工程都是分布式多實(shí)例部署的，如果要查看業(yè)務(wù)的openapi文檔，就需要定位到某一個(gè)具體的應(yīng)用實(shí)例地址來(lái)查看其暴露的openapi文檔，在實(shí)際部署中，實(shí)例的地址可能會(huì)不斷變化(例如部署在kubernetes環(huán)境)，因此就需要配置一些固定的域名映射，來(lái)把openapi的訪問(wèn)地址映射到某個(gè)固定的應(yīng)用實(shí)例。但是當(dāng)該應(yīng)用實(shí)例宕機(jī)后，就會(huì)造成openapi文檔也不可被訪問(wèn)。
7、(2)應(yīng)用實(shí)例暴露的是當(dāng)前所部署代碼的實(shí)時(shí)的openapi規(guī)范文檔，無(wú)法查看到openapi的歷史變化情況。
8、(3)無(wú)法離線查看和導(dǎo)出openapi文檔，例如所有應(yīng)用實(shí)例部署在內(nèi)網(wǎng)環(huán)境中，三方的api消費(fèi)者又無(wú)法連接內(nèi)網(wǎng)環(huán)境直接訪問(wèn)openapi文檔。就需要能夠以離線和獨(dú)立的方式提供一套三方api消費(fèi)者可以訪問(wèn)的openapi環(huán)境，并提供openapi文檔導(dǎo)出功能。
技術(shù)實(shí)現(xiàn)思路
1、針對(duì)上述問(wèn)題，本專利技術(shù)提出了一種基于openapi規(guī)范的集中式文檔采集管理方法，設(shè)置一個(gè)專門的openapi采集管理中心，通過(guò)一定的采集策略，從多實(shí)例部署的業(yè)務(wù)應(yīng)用中選擇一個(gè)實(shí)例，采集其openapi規(guī)范文檔，并按照內(nèi)容變化的軌跡來(lái)存儲(chǔ)其不同的歷史版本。
2、為實(shí)現(xiàn)上述目的，本專利技術(shù)公開(kāi)了一種基于openapi規(guī)范的集中式文檔采集管理方法，包括：
3、基于openapi管理節(jié)點(diǎn)配置或自動(dòng)發(fā)現(xiàn)集群采集信息，包括被采集應(yīng)用的實(shí)例信息、采集頻率信息，存儲(chǔ)到數(shù)據(jù)庫(kù)；
4、openapi采集節(jié)點(diǎn)集群內(nèi)部選出master節(jié)點(diǎn)，master節(jié)點(diǎn)讀取所述數(shù)據(jù)庫(kù)中的所述集群采集信息；
5、master節(jié)點(diǎn)根據(jù)所述集群采集信息中待采集應(yīng)用實(shí)例數(shù)量及所述openapi采集節(jié)點(diǎn)集群中slave節(jié)點(diǎn)的數(shù)量，為各slave節(jié)點(diǎn)分配待采集應(yīng)用實(shí)例，并將待采集應(yīng)用實(shí)例的實(shí)例信息、采集頻率信息同步到對(duì)應(yīng)的slave節(jié)點(diǎn)；
6、slave節(jié)點(diǎn)通過(guò)調(diào)用待采集應(yīng)用實(shí)例的http接口，對(duì)待采集應(yīng)用實(shí)例按采集頻率進(jìn)行openapi文檔的采集；
7、slave節(jié)點(diǎn)基于openapi文檔的摘要信息查詢所述數(shù)據(jù)庫(kù)，若存在相同摘要信息，則結(jié)束當(dāng)前采集，若不存在相同摘要信息，則將當(dāng)前的openapi文檔、摘要信息、時(shí)間戳存儲(chǔ)到數(shù)據(jù)庫(kù)。
8、作為本專利技術(shù)的進(jìn)一步改進(jìn)，其特征在于：
9、針對(duì)部署在裸金屬、物理機(jī)或者虛擬機(jī)環(huán)境的應(yīng)用集群，基于openapi管理節(jié)點(diǎn)配置相應(yīng)的集群采集信息，存儲(chǔ)到數(shù)據(jù)庫(kù)；
10、針對(duì)部署環(huán)境是kubernetes容器環(huán)境的應(yīng)用集群，基于openapi管理節(jié)點(diǎn)自動(dòng)發(fā)現(xiàn)kubernetes命名空間中workload的功能，來(lái)自動(dòng)發(fā)現(xiàn)命名空間中部署的應(yīng)用以及實(shí)例信息，保存到數(shù)據(jù)庫(kù)，并在數(shù)據(jù)庫(kù)中實(shí)時(shí)維護(hù)應(yīng)用以及實(shí)例信息。
11、作為本專利技術(shù)的進(jìn)一步改進(jìn)，openapi采集節(jié)點(diǎn)集群通過(guò)raft協(xié)議進(jìn)行內(nèi)部選主，選出master節(jié)點(diǎn)。
12、作為本專利技術(shù)的進(jìn)一步改進(jìn)，master節(jié)點(diǎn)讀取所述數(shù)據(jù)庫(kù)中的所述集群采集信息，包括：待采集的應(yīng)用實(shí)例的地址，待采集的http路徑，采集頻率。
13、作為本專利技術(shù)的進(jìn)一步改進(jìn)，為各slave節(jié)點(diǎn)分配待采集應(yīng)用實(shí)例，包括：
14、通過(guò)一定的算法為各slave節(jié)點(diǎn)平均分配待采集的應(yīng)用，形成應(yīng)用實(shí)例列表。
15、作為本專利技術(shù)的進(jìn)一步改進(jìn)，slave節(jié)點(diǎn)通過(guò)調(diào)用待采集應(yīng)用實(shí)例的http接口，對(duì)待采集應(yīng)用實(shí)例按采集頻率進(jìn)行openapi文檔的采集；包括：
16、slave節(jié)點(diǎn)收到master同步的待采集應(yīng)用列表后，從應(yīng)用的多個(gè)實(shí)例中，根據(jù)一定的算法選擇其中一個(gè)進(jìn)行采集，得到具體的openapi文檔采集地址(ip/port)，采集http路徑，根據(jù)所配置的采集頻率，在一定的時(shí)間周期內(nèi)通過(guò)調(diào)用應(yīng)用實(shí)例http接口的方式采集對(duì)應(yīng)實(shí)例的openapi文檔。
17、作為本專利技術(shù)的進(jìn)一步改進(jìn)，slave節(jié)點(diǎn)通過(guò)sha-256算法計(jì)算openapi文檔的摘要信息。
18、作為本專利技術(shù)的進(jìn)一步改進(jìn)，消費(fèi)restful接口的三方使用者，通過(guò)openapi管理節(jié)點(diǎn)查詢r(jià)estful接口的openapi文檔信息，及其歷史軌跡變化信息。
19、作為本專利技術(shù)的進(jìn)一步改進(jìn)，所述openapi管理節(jié)點(diǎn)提供相關(guān)http接口測(cè)試工具，根據(jù)openapi規(guī)范文檔一鍵生成相關(guān)接口的測(cè)試內(nèi)容。
20、作為本專利技術(shù)的進(jìn)一步改進(jìn)，所述openapi采集節(jié)點(diǎn)集群與openapi管理節(jié)點(diǎn)支持獨(dú)立隔離部署；
21、將openapi采集節(jié)點(diǎn)集群與應(yīng)用集群部本文檔來(lái)自技高網(wǎng)...
【技術(shù)保護(hù)點(diǎn)】
1.一種基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于，包括：
2.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：
3.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：OpenAPI采集節(jié)點(diǎn)集群通過(guò)Raft協(xié)議進(jìn)行內(nèi)部選主，選出Master節(jié)點(diǎn)。
4.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：Master節(jié)點(diǎn)讀取所述數(shù)據(jù)庫(kù)中的所述集群采集信息，包括：待采集的應(yīng)用實(shí)例的地址，待采集的Http路徑，采集頻率。
5.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：為各Slave節(jié)點(diǎn)分配待采集應(yīng)用實(shí)例，包括：
6.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：Slave節(jié)點(diǎn)通過(guò)調(diào)用待采集應(yīng)用實(shí)例的Http接口，對(duì)待采集應(yīng)用實(shí)例按采集頻率進(jìn)行OpenAPI文檔的采集；包括：
7.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理
8.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：消費(fèi)Restful接口的三方使用者，通過(guò)OpenAPI管理節(jié)點(diǎn)查詢Restful接口的OpenAPI文檔信息，及其歷史軌跡變化信息。
9.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：所述OpenAPI管理節(jié)點(diǎn)提供相關(guān)Http接口測(cè)試工具，根據(jù)OpenAPI規(guī)范文檔一鍵生成相關(guān)接口的測(cè)試內(nèi)容。
10.根據(jù)權(quán)利要求1所述的基于OpenAPI規(guī)范的集中式文檔采集管理方法，其特征在于：所述OpenAPI采集節(jié)點(diǎn)集群與OpenAPI管理節(jié)點(diǎn)支持獨(dú)立隔離部署；
...【技術(shù)特征摘要】
1.一種基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于，包括：
2.根據(jù)權(quán)利要求1所述的基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于：
3.根據(jù)權(quán)利要求1所述的基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于：openapi采集節(jié)點(diǎn)集群通過(guò)raft協(xié)議進(jìn)行內(nèi)部選主，選出master節(jié)點(diǎn)。
4.根據(jù)權(quán)利要求1所述的基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于：master節(jié)點(diǎn)讀取所述數(shù)據(jù)庫(kù)中的所述集群采集信息，包括：待采集的應(yīng)用實(shí)例的地址，待采集的http路徑，采集頻率。
5.根據(jù)權(quán)利要求1所述的基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于：為各slave節(jié)點(diǎn)分配待采集應(yīng)用實(shí)例，包括：
6.根據(jù)權(quán)利要求1所述的基于openapi規(guī)范的集中式文檔采集管理方法，其特征在于：slave節(jié)點(diǎn)通過(guò)調(diào)用待采集應(yīng)用實(shí)例的http...
【專利技術(shù)屬性】
技術(shù)研發(fā)人員：代智，
申請(qǐng)(專利權(quán))人：北京思特奇信息技術(shù)股份有限公司，
類型：發(fā)明
國(guó)別省市：
還沒(méi)有人留言評(píng)論。發(fā)表了對(duì)其他瀏覽者有用的留言會(huì)獲得科技券。