前言
隨著 Web 技術的發展,前後端分離構架變的越來越流行。前端負責數據的展現和交互,大大細化了開發者的職責,提高了開發效率,但與此同時也帶來了一些問題:
對於前端工程師,後端提供的接口文檔大多是不規範的,有使用 wiki 的,有 word 文檔的,甚至還有用即時聊天軟件溝通的,後端接口對於前端就像一個黑盒子,經常遇到問題是接口因未知原因增加參數了,參數名變了,參數被刪除了。對於後端工程師,接口對接時總是需要寫冗雜繁瑣的文檔,需要大量時間去維護接口文檔。
........
還有很多問題就不一一列舉了,只要做過前後端分離項目的開發人員,或者做過APP後臺接口的開發人員,又或者做過微信小程序的開發人員都會懂的。今天不說太多空話,只是給大家分享一個api管理平臺工具,也是我目前在用的一個工具。
市面上關於api管理的工具/系統其實有很多很多,知乎上搜一下各種對比介紹都有,我當時就是這麼過來的,咱今天也不爭辯誰好誰壞。
關於Yapi
YApi是去哪兒移動架構組開源的API管理系統,是一款完全免費的api管理平臺。
官網地址:
示例地址:
使用教程:
系統界面也是很簡潔的
其主要特點如下:
· 權限管理
YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求
· 可視化接口管理
基於 websocket 的多人協作接口編輯功能和類 postman 測試工具,讓多人協作成倍提升開發效率
· Mock Server
易用的 Mock Server,再也不用擔心 mock 數據的生成了
· 自動化測試
完善的接口自動化測試,保證數據的正確性
· 數據導入
支持導入 swagger, postman, har 數據格式,方便遷移舊項目
· 插件機制
強大的插件機制,滿足各類業務需求
安裝Yapi
Yapi有兩種使用方式,一種是在線使用官方提供的系統,這種肯定不適用與大部分公司,另外一種是下載並安裝到指定服務器,我們這裡介紹下載安裝到centos中。
官方教程中有關於內網部署系統的文檔說明,但是我在使用的過程中發現有一些坑,安裝過程可能沒有文檔寫的那麼的簡單。
內網部署文檔:
安裝環境要求:
· nodejs(7.6+) yapi是用nodejs開發的,所以需要此環境編譯運行
· mongodb(2.6+) 用來存儲系統的數據
· git 為了在線下載yapi源碼
方式一. 可視化部署[推薦]
執行 yapi server 啟動可視化部署程序,輸入相應的配置和點擊開始部署,就能完成整個網站的部署。部署完成之後,可按照提示信息,執行 node/{網站路徑/server/app.js} 啟動服務器。在瀏覽器打開指定url, 點擊登錄輸入您剛才設置的管理員郵箱,默認密碼(ymfe.org) 登錄系統(默認密碼可在個人中心修改)。
方式二. 命令行部署
*如果 github 壓縮文件無法下載,或需要部署到一些特殊的服務器,可嘗試此方法
注:上述安裝都會有個很大的問題,就是npm的使用,網絡原因,npm在執行某些命令的時候經常卡死不動,這個時候需要採用淘寶提供的景象才可以。可以看這裡或者請教專業前端人員。
安裝後配置
以上兩種方法執行後,都只是完成了系統的初步安裝,還需要打開瀏覽器頁面,完成系統的配置才行。
這裡以第一種方式為例:
第一個命令執行後:
根據信息,需要切換到對應的目錄才能執行yapi命令
然後打開瀏覽器訪問即可,記得關閉防火牆
瀏覽器打開是個配置頁面,填寫基本信息:
數據庫認證那裡,默認安裝的mongodb是沒有密碼的,所以不需要認證,如果修改了密碼,那就需要填寫了
填寫後確定,就會彈出安裝進度信息:
後臺系統也會實時打印日誌信息:
安裝過程可能會慢一點,需要耐心等待了。如果以上方式失敗了,嘗試第二種,先把文件下載瞭然後安裝。
安裝後就可以訪問使用系統了:
登錄用戶名就是配置的管理員郵箱,密碼默認是 ymfe.org,登陸後可以自行修改。
默認啟動是前臺啟動,我們需要改為後臺運行才可以。這裡推薦使用pm2管理node服務器的啟動、停止等。官網教程中有說明。如果你會npm,你會很在行的。
登錄之後的系統長這個樣子:
關於系統的使用,可以參考官網的教程,介紹的還是很詳細的。或者等我改天再分享。
補充
以下補充的知識僅為本文的yapi服務,所以不做過多介紹,只說明基本操作。
git安裝
一個命令:
mongodb安裝
官網安裝文檔:
1、 在/etc/yum.repos.d創建一個mongodb-org.repo源文件
這段內容可以從mongodb官網複製,根據你所安裝的版本選擇
保存退出
2、 更新yum源
3、 安裝mongodb
4、 啟動mongod服務
5、 設置為開機啟動
6、 配置遠程訪問,默認只能本機訪問。如果不需要遠程訪問,這一步可以省略
mongodb配置文件為/etc/mongod.conf:
默認監聽127.0.0.1,註釋掉即可遠程訪問
7、 如果需要修改認證,建議查閱相關文檔,這裡不再介紹
nodejs安裝
官網下載所需要的nodejs,建議下載8.*,淘寶鏡像下載地址:
我這裡下載的壓縮包:
解壓即可:
將解壓後的文件目錄配置到path中即可使用npm相關命令:
測試命令是否可用:
pm2安裝
一行命令搞定:
常用命令:
還可以關注我的微信公眾號一同交流:code_mrzhou
閱讀更多 JAVA周老師 的文章