[發明專利]一種基于應用系統群整體的API信息管理的方法

在審

• 申請號: 202211270885.8
• 申請日: 2022-10-14
• 公開（公告）號: CN115617393A
• 公開（公告）日: 2023-01-17
• 發明（設計）人: 陳韜;章文;吳尚璟;田駿
• 申請（專利權）人: 武漢眾邦銀行股份有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F8/71
• 代理公司: 成都正煜知識產權代理事務所(普通合伙) 51312
• 代理人: 袁宇霞

1.一種基于應用系統群整體的API信息管理的方法，其特征在于，包括以下步驟：

步驟1：對應用系統的測試環境循環抽取接口數據，得到純報文日志；

步驟2：搭建API管理平臺，用于數據查詢腳本管理，包括以下模塊：

數據腳本管理模塊：用于在線維護腳本的增刪改成；

腳本啟動管理模塊：根據使用場景設定腳本執行觸發邏輯；

系統接口管理模塊：可視化、格式化展示當前應用系統最新的接口清單和接口詳情；

接口變更處理模塊：分析接口數據，判斷接口數據中是否存在格式變更，并提供特定時間范圍內的接口變更記錄查詢功能；

步驟3：根據步驟2中搭建的數據腳本管理，開發人員在線編寫腳本，腳本處理邏輯為：

步驟3.1、依次讀取步驟1中獲取的接口數據；

步驟3.2、分別存儲接口數據中的請求格式、請求字段，返回格式和返回字段，并依次打上查詢頻率標記id與數據id；

步驟4：根據步驟2中搭建的腳本啟動管理功能，在API管理平臺設置腳本的查詢頻率、手工/定時啟動方式；

步驟5：根據步驟2中搭建的腳本啟動管理功能，通過手工啟動和定時啟動的方式來啟動步驟3中編寫的數據腳本，讀取步驟4設置的查詢頻率來查詢接口數據，每次查詢時將本次查詢周期內的接口信息數據，包括接口的請求格式、請求字段，返回格式和返回字段等數據進行解析存儲入庫；

步驟6：獲得步驟5的節點信息數據后，API管理平臺根據步驟2中搭建的接口變更處理功能，將歷史接口信息與新數據進行去重對比，判斷本次周期內的接口信息數據是否有變更，有變更則自動更新最新的接口清單和接口詳情，同時通過企業微信通知相關方，API管理平臺提供輸出pdf格式的接口文檔，供開發人員與測試人員使用。

2.根據權利要求1所述的一種基于應用系統群整體的API信息管理的方案，其特征在于，步驟1主要是部署Splunk系統并建立好索引，具體包括以下步驟：

步驟1.1：部署Splunk系統，通過Splunk對系統群下的應用系統的測試環境日志進行抓取，并存儲到Splunk數據庫中；

步驟1.2：為各類系統建立索引，加快查詢數據；

步驟1.3：利用步驟1.2中建立的索引篩選純報文日志；

3.根據權利1所述的一種基于應用系統群整體的APl信息管理的方案，其特征在于，步驟2主要是利用SpringBroot后端框架與VUE前端框架搭建搭建API管理平臺用于數據查詢腳本管理，具體實現包括：

步驟2.1：API管理平臺提供數據查詢腳本文件管理功能，包括腳本上傳新增、在線編輯、在線調試、在線預覽和刪除功能，方便系統群下的開發人員線上編輯數據腳本；

步驟2.2：API管理平臺提供數據查詢腳本啟動管理功能，包括管理腳本執行頻率，啟動方式，腳本熱啟動功能，方便系統群下的開發人員根據使用場景設定腳本執行觸發邏輯；

步驟2.3：API管理平臺提供可視化、格式化的接口清單和接口詳情預覽功能，方便系統群下的全體人員可實時查看最新的接口信息；

步驟2.4：API管理平臺按頻率批次存儲數據腳本處理之后的接口數據，方便追溯某一版本下的接口的變更記錄。

4.根據權利1所述的一種基于應用系統群整體的API信息管理的方案，其特征在于，步驟3為數據腳本編寫階段，系統群下的開發人員根據本應用系統的接口文檔格式，在線編寫數據查詢處理腳本，腳本處理邏輯如下：

步驟3.1、數據處理腳本通過步驟1中獲取的純報文日志，提取報文中的請求碼、請求字段、請求字段格式、返回字段、返回字段格式；

步驟3.2、數據處理腳本將步驟3.1中的請求碼、請求字段、請求字段格式，返回字段、返回字段格式分別存儲至APl管理平臺，并打上查詢頻率標記id與數據id。

5.根據權利1所述的一種基于應用系統群整體的APl信息管理的方案，步驟4為設置腳本的查詢頻率和啟動方式；