[發(fā)明專利]一種基于應(yīng)用系統(tǒng)群整體的API信息管理的方法

在審

• 申請(qǐng)?zhí)枺?/td>: 202211270885.8
• 申請(qǐng)日: 2022-10-14
• 公開(kāi)（公告）號(hào): CN115617393A
• 公開(kāi)（公告）日: 2023-01-17
• 發(fā)明（設(shè)計(jì)）人: 陳韜;章文;吳尚璟;田駿
• 申請(qǐng)（專利權(quán)）人: 武漢眾邦銀行股份有限公司
• 主分類號(hào): G06F8/73
• 分類號(hào): G06F8/73;G06F8/71
• 代理公司: 成都正煜知識(shí)產(chǎn)權(quán)代理事務(wù)所(普通合伙) 51312
• 代理人: 袁宇霞

本發(fā)明涉及研發(fā)領(lǐng)域、測(cè)試技術(shù)領(lǐng)域，提供了一種基于應(yīng)用系統(tǒng)群整體的API信息管理的方法。主旨方便項(xiàng)目組在研發(fā)、測(cè)試過(guò)程中，通過(guò)無(wú)感監(jiān)控測(cè)試環(huán)境的接口請(qǐng)求和應(yīng)答數(shù)據(jù)，自動(dòng)更新當(dāng)前系統(tǒng)的API信息，并通知項(xiàng)目相關(guān)方；方案將解決：跨系統(tǒng)的接口變更溝通完全依賴人工，極易出現(xiàn)遺漏和錯(cuò)誤；測(cè)試人員無(wú)法準(zhǔn)確獲取當(dāng)前版本內(nèi)的接口變更范圍，無(wú)法做到精準(zhǔn)測(cè)試。主要方案包括：1.部署Splunk系統(tǒng)，逐步接入全部應(yīng)用系統(tǒng)群，作為系統(tǒng)群日志管理系統(tǒng)；2.搭建API管理平臺(tái)，a管理各類系統(tǒng)批量查詢Splunk日志數(shù)據(jù)庫(kù)腳本；b管理腳本啟動(dòng)與定時(shí)任務(wù)；c按時(shí)間存儲(chǔ)腳本查詢結(jié)果；3.解析查詢結(jié)果，判斷接口是否有變化；4.更新API信息并通知相關(guān)方。

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

本發(fā)明涉及DevOps(持續(xù)交付)技術(shù)領(lǐng)域、軟件研發(fā)領(lǐng)域，軟件測(cè)試領(lǐng)域，是一種基于應(yīng)用系統(tǒng)群整體的API信息管理方案，作為聯(lián)動(dòng)治理多系統(tǒng)的API信息的方法。

背景技術(shù)

DevOps(持續(xù)交付)：由配置管理、構(gòu)建與持續(xù)集成、測(cè)試管理、部署與發(fā)布管理、環(huán)境管理、數(shù)據(jù)管理、度量與反饋7大能力子域，共14個(gè)能力項(xiàng)構(gòu)成。使用閉環(huán)的工具、平臺(tái)組合，強(qiáng)約束力代碼分支策略手段，高覆蓋率的自動(dòng)化測(cè)試手段，強(qiáng)大的部署自動(dòng)化手段確保項(xiàng)目管理流暢，高質(zhì)量交付，部署可重復(fù)性。但在DevOps(持續(xù)交付)過(guò)程中，項(xiàng)目組的API管理工作很大程度依賴人工，系統(tǒng)群整體的APl管理比較困難，比如以下場(chǎng)景：

①項(xiàng)目組內(nèi)部的接口文檔的及時(shí)更新只出現(xiàn)在小范圍內(nèi)，研發(fā)與測(cè)試之間存在一定時(shí)差，沒(méi)法及時(shí)交互，導(dǎo)致測(cè)試過(guò)程中經(jīng)常發(fā)現(xiàn)接口文檔錯(cuò)誤，出現(xiàn)因文檔錯(cuò)誤阻斷測(cè)試過(guò)程的現(xiàn)象；

②項(xiàng)目組內(nèi)部無(wú)法準(zhǔn)確知曉當(dāng)前版本的接口變更范圍，研發(fā)的變更范圍依賴人工，當(dāng)人員出現(xiàn)流動(dòng)性和工作失誤，可能會(huì)出現(xiàn)遺漏范圍或者擴(kuò)大范圍，遺漏范圍導(dǎo)致漏測(cè)，擴(kuò)大范圍導(dǎo)致人力成本增加；

③各項(xiàng)目組之間的接口文檔的及時(shí)更新缺失，因上下游系統(tǒng)之前接口變更未及時(shí)溝通，導(dǎo)致單系統(tǒng)更改上線后，配套系統(tǒng)未及時(shí)更新從而出現(xiàn)生產(chǎn)問(wèn)題；

④項(xiàng)目群下快速收集多套系統(tǒng)的API信息較為困難。

技術(shù)缺陷：

目前上線后出現(xiàn)生產(chǎn)事故，主要原因是第②和第③點(diǎn)引出的測(cè)試范圍問(wèn)題導(dǎo)致的，尤其第②點(diǎn)，項(xiàng)目組流動(dòng)性過(guò)大時(shí)，對(duì)于存量代碼的掌控很較弱，擴(kuò)大范圍后的回歸測(cè)試可能依然無(wú)法避免漏測(cè)，而且極消耗人力成本。現(xiàn)有API管理的方案如下：

a.人工整理；

b.代碼中集成開(kāi)源的API管理框架，如swagger；

c.Excel文檔整理后通過(guò)git進(jìn)行版本控制；

其中a、c耗費(fèi)人力，且容易出現(xiàn)更新不及時(shí)的情況，全部系統(tǒng)都能實(shí)現(xiàn)較高質(zhì)量的API管理不太現(xiàn)實(shí)；b對(duì)原有的代碼框架要求很高，不是所有系統(tǒng)都適用，存在推廣難點(diǎn)，無(wú)法全部適配，推廣效果會(huì)打折扣。

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

本發(fā)明的目的在于解決系統(tǒng)群的API管理實(shí)施困難問(wèn)題，從而減輕由文檔更新不及時(shí)導(dǎo)致的研發(fā)測(cè)試失誤出現(xiàn)的缺陷逃逸風(fēng)險(xiǎn)。

為了解決上述技術(shù)問(wèn)題，本發(fā)明采用以下技術(shù)手段：

一種基于應(yīng)用系統(tǒng)群整體的API信息管理的方案，包括以下步驟：

步驟1：對(duì)應(yīng)用系統(tǒng)的測(cè)試環(huán)境循環(huán)抽取接口數(shù)據(jù)，得到純報(bào)文日志；

步驟2：搭建API管理平臺(tái)，用于數(shù)據(jù)查詢腳本管理，包括以下模塊：

數(shù)據(jù)腳本管理模塊：用于在線維護(hù)腳本的增刪改成；

腳本啟動(dòng)管理模塊：根據(jù)使用場(chǎng)景設(shè)定腳本執(zhí)行觸發(fā)邏輯；

系統(tǒng)接口管理模塊：可視化、格式化展示當(dāng)前應(yīng)用系統(tǒng)最新的接口清單和接口詳情；