背景
最近在找一款API文檔管理工具,之前有用過Swagger、API Manager、Confluence,現在用的還是Confluence。
我個人一直不喜歡用Swagger,感覺“代碼即文檔”,讓代碼里的文檔無處不在,已經對代碼造成了一定的入侵了。API Manager就是一個純API文檔管理的工具了。Confluence是萬能的,也是最簡單的,支持各種插件在線安裝,可以有各種布局,支持MD文檔,也支持表格、代碼塊等。
最近看到一篇文章在說YAPI,就準備搭建一個試試效果如何。
YAPI簡介
YAPI是去哪兒網開源的一款API管理工具,理念如下:
YApi讓接口開發更簡單高效,讓接口的管理更具可讀性、可維護性,讓團隊協作更合理。
特性:
基于 Json5 和 Mockjs 定義接口返回數據的結構和文檔,效率提升多倍
扁平化權限設計,即保證了大型企業級項目的管理,又保證了易用性
類似 postman 的接口調試
自動化測試, 支持對 Response 斷言
MockServer 除支持普通的隨機 mock 外,還增加了 Mock 期望功能,根據設置的請求過濾規則,返回期望數據
支持 postman, har, swagger 數據導入
免費開源,內網部署,信息再也不怕泄露了
選擇YAPI試試手的原因是因為我看到了它支持MockServer,這樣前端開發同學就不用等待后端同學了。主要是我也懶得搭建一套mock服務,有這樣一款工具何樂而不為呢?所以今天就找了一臺服務器安裝了一下。考慮排版問題,就以圖片形式放出來了。
依賴環境
- 系統版本:linux centos 7.4
- nodeJS
- MongoDB
- Git
安裝步驟
nodeJs安裝
nodeJS長期支持版本官網下載地址:https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz,下載后執行如下命令:
nodeJS安裝命令
nodeJS安裝完畢。
MongoDB安裝
MongoDB安裝命令
Git安裝
#yum安裝,這個最簡單了 yum -y install git
YAPI安裝
YAPI安裝,GitHub上已經有比較詳細的文檔了,地址:https://github.com/YMFE/yapi,這里說一下兩種部署方式:
可視化部署:
YAPI可視化部署
yapi安裝完畢,訪問http://127.0.0.1:9090進行可視化配置一步一步往下走即可。
命令行部署(推薦方式):
命令行部署(推薦)
yapi安裝完畢,訪問http://127.0.0.1:{config.json中配置的port}即可訪問。
后臺運行YAPI
node需要安裝pm2模塊,使用pm2模塊后臺運行yapi:
pm2運行yapi
運行成功頁面:
yapi運行成功頁面
至此,YAPI就安裝完畢了,簡單實用一下還是不錯的,因為是國產的,整體操作風格還是比較習慣的。在YAPI這里接口更改還有記錄哦~
YAPI控制臺
后面再慢慢體驗這個里面的一些高級功能吧,比如MockServer、接口測試等功能。
大家還有什么更好用的API管理工具?你覺得一款優秀的API管理工具應該都有哪些必須的功能?歡迎推薦和討論!