SBDoc接口管理和自動化測試內(nèi)網(wǎng)配置和mac搭建局域網(wǎng)
公司開發(fā)項目一直沒有用接口管理工具,接口文檔也是使用word文檔,協(xié)同開發(fā)起來很麻煩。我在網(wǎng)上也找了其他的接口管理的工具,但是很多接口管理工具的數(shù)據(jù)都是在他們自己的服務(wù)器上??紤]接口文檔的安全性所以只能找開源的工具然后部署到自己的服務(wù)器上,然后就了解到了SBDoc。
簡單介紹一下SBDoc,作者是計劃(不知道是不是真名,感覺是一個有故事的大神詳細(xì)介紹)SBDoc不僅集成了文檔編寫,團隊協(xié)作,接口運行,mock數(shù)據(jù)等功能,還有兩個功能是讓我們團隊大大的提高工作效率的。一個是接口的自動化生成,可以根據(jù)接口數(shù)據(jù)自動生成文檔信息,還有一個便是接口的自動化測試!附上SBDoc線上版本
今天我給大家介紹的是關(guān)于內(nèi)網(wǎng)配置(mac)。
1.首先本地要安裝node環(huán)境,推薦6.10.0版本(下載頁面)
2.安裝mongodb(下載頁面),可使用robomongo來作為mongodb的客戶端工具(下載頁面)。這里不推薦大家直接下載安裝,最好使用終端安裝,附上終端安裝教程,安裝完成后需要開啟。終端安裝mongodb需要通過homebrew 來安裝(附上安裝教程) 。
下載robomongo后點擊安裝,安裝完成后還會出現(xiàn)以下界面(當(dāng)然沒有創(chuàng)建數(shù)據(jù)庫的話是不會有test那個項目的,那是我創(chuàng)建過的)

點擊創(chuàng)建后的界面(test是我之前創(chuàng)建的,正常第一次打開是什么都沒有的)。

點擊Create后進入創(chuàng)建頁面,輸入數(shù)據(jù)庫名稱,其他使用默認(rèn)設(shè)置即可,點擊Save。

返回上一級頁面點擊繼續(xù),會創(chuàng)建成功。
3.將SBDoc的源碼down到本地,進入根目錄,修改config.json
{
"db":"mongodb://localhost:27017/SBDoc", ?//這里為你的mongodb服務(wù)器的地址和庫的名稱
"filePath":"/Users/Shared/SBDoc", ?//這里作為SBDoc文件上傳的路徑
"imgPath":"/Users/Shared/SBDoc/img", ?//這里是SBDoc圖片上傳的路徑(是SBDoc文件上傳的路徑的直接子目錄) ?
?"tempPath":"/Users/Shared/SBDoc/temp", //這里SBDoc臨時文件上傳的路徑(是SBDoc文件上傳的路徑的直接子目錄) ?
?"port":10000, ?//SBDoc啟動的端口號
"version":"1.0.0" ?//SBDoc的版本號(無需修改)
}
給你們附上我的config.json
{
"db":"mongodb://localhost:27017/test",
"filePath":"/Users/liangqianyong/desktop/SBDoc",
"imgPath":"/Users/liangqianyong/desktop/SBDoc/img",
"tempPath":"/Users/liangqianyong/desktop/SBDoc/temp",
"port":10000,
"version":"2.1.2"
}
需要注意的是filePath、imgPath、tempPath需要是真實存在的路徑。
4.在命令行下運行node SBDoc的根目錄/SBDoc/bin/www即可啟動SBDoc(如果是windows環(huán)境下,請修改目錄分隔符),在瀏覽器里輸入localhost:SBDoc啟動的端口號,出現(xiàn)首頁表示部署成功。附上我的路徑示例:/Users/liangqianyong/Downloads/SBDoc-master/SBDoc/bin/www
以上所有的本地環(huán)境都搭建好了,現(xiàn)在在瀏覽器輸入localhost:你的端口號會出現(xiàn)首頁,如果沒有出現(xiàn)請自行對照步驟排查。
下面是搭建局域網(wǎng)
macbook 上沒有網(wǎng)線插口,所以需要一個雷電以太網(wǎng)轉(zhuǎn)接器或者是usb以太網(wǎng)轉(zhuǎn)接器,能夠保證電腦聯(lián)網(wǎng)。詳細(xì)教程請戳構(gòu)建局域網(wǎng)。
以上步驟完成后,使用同一路由器的電腦或者是連接你的服務(wù)器電腦熱點的電腦都可通過服務(wù)器電腦的ip:端口號訪問主頁。
在說明一下,每次電腦重啟后都需要重新打開mongodb后運行node SBDoc的根目錄/SBDoc/bin/www即啟動SBDoc。
github:https://github.com/sx1989827/SBDoc
該教程多是把網(wǎng)上的教程做了個統(tǒng)一,方便查閱。SBDoc交流群:611940610 ?我的QQ:929245885 ?有什么不足歡迎指出。?