接口系統(tǒng)操作手冊(cè)
? ? ? ?
?
?
數(shù)據(jù)接口管理系統(tǒng)操作手冊(cè)
?
?
?
?
?
?
技術(shù)支持
坦克之榮
產(chǎn)品版本
V1.0
發(fā)布日期
2023-3-28
?
?
?
?
?
單擊或點(diǎn)擊此處輸入文本。
?
?
目錄
簡(jiǎn)介... 3
產(chǎn)品/服務(wù)/方法... 4
系統(tǒng)功能... 8
升級(jí)規(guī)劃... 13
?
?
簡(jiǎn)介
?
數(shù)據(jù)接口管理系統(tǒng)是一款Python+Oracle數(shù)據(jù)庫開發(fā)的用于管理oracle數(shù)據(jù)庫調(diào)用第三方api的前端管理軟件,設(shè)計(jì)之初本著一切皆可配置的設(shè)計(jì)思路,系統(tǒng)加入了多個(gè)配置文件。
軟件為綠色版,無需安裝oracle客戶端,無需安裝本軟件,解壓即用,無路徑要求限制。
通過本軟件可實(shí)現(xiàn)oracle數(shù)據(jù)庫的用戶創(chuàng)建,用戶授權(quán),腳本更新,job任務(wù)管理(新建、刪除、啟動(dòng)、停止),接口數(shù)據(jù)日志監(jiān)控,接口調(diào)試等相關(guān)功能,本軟件也可提供定制化功能開發(fā)。
?
?
系統(tǒng)初始化首次運(yùn)行軟件,需要根據(jù)oracle服務(wù)器進(jìn)行初始化連接配置,如果不做初始化,也可以用來做一個(gè)接口測(cè)試工具,但數(shù)據(jù)庫相關(guān)管理功能將無法使用。
初始化詳細(xì)步驟如下,
第一步∶輸入賬號(hào)密碼(默認(rèn)賬號(hào)為admin密碼為databox)不選擇配置直接點(diǎn)擊登錄即可登錄系統(tǒng)主界面,如下圖顯示
圖一:登錄界面
圖二:系統(tǒng)主界面
第二步∶點(diǎn)擊菜單中的工具菜單,選擇系統(tǒng)初始化,彈出初始化窗口,根據(jù)窗口下面的提示信息完成相關(guān)內(nèi)容的錄入,然后點(diǎn)擊創(chuàng)建,系統(tǒng)會(huì)自動(dòng)在指定實(shí)例下創(chuàng)建一個(gè)新用戶,并切換至授權(quán)頁面,如下圖所示
圖三:初始化界面
第三步∶授權(quán)頁面根據(jù)需要勾選相應(yīng)的權(quán)限,本界面需要有對(duì)oracle有一定認(rèn)識(shí)基礎(chǔ)的人操作,見下圖
圖四:授權(quán)選擇
第四步∶授權(quán)勾選完成后點(diǎn)擊下一步進(jìn)入補(bǔ)丁更新頁面,根據(jù)自己寫的接口相關(guān)腳本導(dǎo)入依賴和接口執(zhí)行腳本,如下圖所示
圖五:補(bǔ)丁更新
第五步:在導(dǎo)入腳本過程中可能會(huì)出現(xiàn)失效對(duì)象,點(diǎn)擊下一步進(jìn)入對(duì)象檢查頁面,選擇對(duì)應(yīng)的失效對(duì)象,即可看到導(dǎo)致對(duì)象失效的列表信息。,打開對(duì)應(yīng)腳本,修改錯(cuò)誤地方或聯(lián)系腳本提供人員進(jìn)行修改,修改后可通過腳本更新功能進(jìn)行更新,如下圖所示
圖六:失效對(duì)象檢查
?
至此,系統(tǒng)初始化完成。
初始化完成后退出系統(tǒng)重新登陸,在登錄界面的配置里面選擇自己新建的實(shí)例配置,如下圖
圖七:選擇配置登錄
選擇實(shí)例配置時(shí)需要注意配置下面的提示,如果為綠色字體提示配置成功,說明初始化沒有漏項(xiàng),如果為黃色字體提示配置加載成功但缺少相應(yīng)的表,說明初始化的時(shí)候漏掉了基本配置的相關(guān)表腳本更新,如果為紅色字體提示,需要根據(jù)提示內(nèi)容分析原因,配置沒有問題的情況點(diǎn)擊登錄即可進(jìn)入主界面
?
?
系統(tǒng)功能在主界面可以進(jìn)行以下操作
1.主任務(wù)——接口配置
用于新增接口或修改原接口信息
如下圖:
圖八:接口配置
2.主任務(wù)——參數(shù)配置
配置系統(tǒng)參數(shù)表,控制接口的控制參數(shù)
如下圖:
圖九:參數(shù)配置
3.工具——腳本更新
用于日常功能開發(fā)后的腳本更新和失效對(duì)象檢查
圖十:腳本更新
4.主界面——任務(wù)監(jiān)控
用于新job任務(wù)的創(chuàng)建,啟停,刪除等功能操作,通過右鍵菜單進(jìn)行相應(yīng)菜單選擇
圖十一:任務(wù)監(jiān)控
5.主界面——日志查詢
指定日期查詢數(shù)據(jù)接口發(fā)送數(shù)據(jù)情況,對(duì)于異常數(shù)據(jù)可以右鍵復(fù)制數(shù)據(jù)到接口測(cè)試功能處進(jìn)行數(shù)據(jù)發(fā)送測(cè)試
圖十二:日志監(jiān)控
6.主界面——接口調(diào)試
1)用于對(duì)新接口和老接口的測(cè)試,地址欄可以輸入接口地址,如果配置了數(shù)據(jù)連接和接口,該處也可直接選擇對(duì)應(yīng)的接口地址進(jìn)行測(cè)試
圖十三:接口調(diào)試
2)接口分為get和post
圖十四:GET接口調(diào)試
?
圖十五:POST接口調(diào)試
3)可選擇是前端直接測(cè)試,也可選擇直接調(diào)用數(shù)據(jù)庫端的單條記錄測(cè)試
4)可動(dòng)態(tài)配置用戶id和密鑰還有Token值
?
?
?
?
?
升級(jí)規(guī)劃?
1.增加服務(wù)功能,實(shí)現(xiàn)接受發(fā)送數(shù)據(jù)雙任務(wù)功能
2.逐步替代oracle的計(jì)劃任務(wù),改由服務(wù)實(shí)現(xiàn)
3.利用python的爬蟲功能實(shí)現(xiàn)知識(shí)庫功能
4.增加B端接口管理界面
?
?
?
?
?
?
?
?
?
?
?
?