1.YApi介紹
YApi 是高效、易用、功能強大的 api 管理平臺,旨在爲開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕鬆創建、發佈、維護 API,YApi 還爲用戶提供了優秀的交互體驗,開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理。(引用官方)
2.特點
- 基於 Json5 和 Mockjs 定義接口返回數據的結構和文檔,效率提升多倍
- 扁平化權限設計,即保證了大型企業級項目的管理,又保證了易用性
- 類似 postman 的接口調試
- 自動化測試, 支持對 Response 斷言
- MockServer 除支持普通的隨機 mock 外,還增加了 Mock 期望功能,根據設置的請求過濾規則,返回期望數據
- 支持 postman, har, swagger 數據導入
- 免費開源,內網部署,信息再也不怕泄露了 (還是引用官方,哈哈)
3.安裝
官方列舉了好幾種搭建方式,我試了幾種,但是都沒有成功,都卡在點擊登陸的時候沒反應了,所以我還是介紹我搭建成功的教程吧。灰塵簡單。我是使用docker搭建的。
注:此教程默認你已經安裝好了docker
步驟一:創建mongoDB數據卷
docker volume create mongo_data_yapi
步驟二:啓動 MongoDB
docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo
步驟三:從阿里雲倉庫獲取yapi鏡像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
步驟四:初始化 Yapi 數據庫索引及管理員賬號
docker run -it --rm --link mongo-yapi:mongo --entrypoint npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server
步驟五:創建yapi容器並啓動
docker run -d --name yapi --link mongo-yapi:mongo --workdir /api/vendors -p 3000:3000 registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js
接下來訪問ip:3000來訪問yapi服務
註冊一個賬號使用:
註冊好會自動登陸進去:
接下來就可以愉快的使用yapi了,這期主要將yapi環境的搭建,有空寫一篇如何使用idea集成yapi插件輕鬆無代碼侵入方便快捷測試自己的接口。
tip:可以在自己的公有云搭建一個這樣的服務,然後就可以在任意地方方便的測試自己的接口了