部署
詳細部署流程可以查看 YAPI 官方文檔>內網部署
這里我們開發者學習, 建議找個docker 鏡像, 一鍵安裝, 這里我們使用的是 fjc0k/docker-YApi
通過 download 解壓壓縮包, docker-compose 部署:
-
修改 docker-compose.yml 中的郵箱YAPI_ADMIN_ACCOUNT 和 YAPI_ADMIN_PASSWORD.
-
啟動服務:
在docker-compose.yml所在目錄下執行
docker-compose up -d -
打開 YAPI服務地址 登錄
基本操作
進入主頁后, 有操作引導, 創建項目等操作很簡單,不做過多介紹. 介紹一些平時使用頻率比較高的操作.
詳細操作請移步官方使用文檔
數據導入
支持: swagger , postman , json , HAR 多種格式
項目中選中 數據管理 > 數據導入 選擇你需要的格式
在線測試
可以自定義多種用例.
選中項目中
接口 > 測試集合> 添加測試集合
選中添加的
斷言
測試結果
總體來說, 還是有一定局限性的. 比方說 我沒有找到 設置前置動作和后置動作的入口.
也許有通過開放 API接入自動化平台 或者 自定義插件實現吧. 期待
Mock Server
支持入參, 響應結果 mock 期望
測試 case 入參 mock
響應結果mock
數據導出
導出格式:html,markdown,json
安裝插件
YAPI 伸縮性很強, 開放的插件開發窗口. 點擊查看開源 YApi 插件列表
在 docker-Yapi 中我們只要在 docker-compose.yaml 中配置即可
比如 我們這里要裝 自動化測試插件
以fjc0k/docker-YApi為例, 我們做一下配置
在 docker-compose.yaml 這樣配置
去掉前綴 yapi-plugin-
YAPI_PLUGINS=[{"name":"auto-test"}]
之后重啟 yapi-web 容器
docker-compose restart yapi-web
開放 API
通過 YAPI 的開放 API 可以做很多事情, 比如對接私有平台, 比如開發插件等等.
總結
- UI 舒服, 用戶操作體驗極佳
- 可視化接口管理, 支持附件上傳、圖片預覽等場景富文本編輯器功能
- 支持內網部署
- 在線測試, 自動化測試
- 多版本/ 團隊協作功能
- Mock Server
- 多種格式的數據導入導出
- 支持自定義插件
- 提供開發 API
思考
這里會發現我們在編寫完 Yapi 接口之后. 在代碼中仍然要寫一遍注釋.雖然也只寫了兩邊. 但是也還是覺得麻煩.
這里我們引入下文. IDEA 插件 EasyYapi
寫在最后
還是老三樣. 歡迎 點贊, 轉發, 評論 ~
