docker搭建yapi介面文檔系統、Idea中上傳介面、在線調用
一、前言
在我們後端開發中，必不可少的是介面的交接，有很多種方式，常見的就是swagger，不過這個侵入性太強了。還有就是介面文檔的框架，比如今天小編帶大家一起搭建的yapi，在公司還是挺常見的！
今天小編就大家從搭建到使用，詳細的教學一波哈！！
二、介紹
1. 平台介紹
YApi 是高效、易用、功能強大的 api 管理平台，旨在為開發、產品、測試人員提供更優雅的介面管理服務。可以幫助開發者輕鬆創建、發布、維護 API，YApi 還為用戶提供了優秀的交互體驗，開發人員只需利用平台提供的介面數據寫入工具以及簡單的點擊操作就可以實現介面的管理。
2. 特性
- 基於 Json5 和 Mockjs 定義介面返回數據的結構和文檔，效率提升多倍
- 扁平化許可權設計，即保證了大型企業級項目的管理，又保證了易用性
- 類似 postman 的介面調試
- 自動化測試, 支援對 Response 斷言
- MockServer 除支援普通的隨機 mock 外，還增加了 Mock 期望功能，根據設置的請求過濾規則，返回- – 期望數據
- 支援 postman, har, swagger 數據導入
- 免費開源，內網部署，資訊再也不怕泄露了
3. 環境支援
- nodejs（7.6+)
- mongodb（2.6+）
- git
在docker中只需要搭建一下mongo，用來數據的存儲即可！
三、運行mongo
0. 創建網路
docker network create yapi
1. 創建掛載文件
mkdir -p /data/mongo
2. 運行mongo
docker run -d \
--name mongodb \
--restart always \
--net=yapi \
-p 27017:27017 \
-v /data/mongo:/data/db \
-e MONGO_INITDB_DATABASE=yapi \
-e MONGO_INITDB_ROOT_USERNAME=yapi \
-e MONGO_INITDB_ROOT_PASSWORD=yapi \
mongo
啟動 MongoDB，其中 -e 指定 MONGO_INITDB_ROOT_USERNAME 為 MongoDB 的 ROOT 用戶名，MONGO_INITDB_ROOT_PASSWORD 為 MongoDB 的 ROOT 用戶密碼
3. 進入容器初始化資料庫
進入 MongoDB 容器，從上圖查看 MongoDB 容器可以獲取到容器 id，以下示例使用 50f1f6c50139代表 MongoDB 的容器 id，只需要簡寫即可！
docker exec -it 50 /bin/bash
接著輸入：
mongosh
新版本需要加上sh，不然無法進入！
use admin;
db.auth("yapi", "yapi");
# 創建 yapi 資料庫
use yapi;
# 創建給 yapi 使用的帳號和密碼，限制許可權
db.createUser({
user: 'yapi',
pwd: 'yapi',
roles: [
{ role: "dbAdmin", db: "yapi" },
{ role: "readWrite", db: "yapi" }
]
});
# 退出 Mongo Cli
exit
# 退出容器
Ctrl+P+Q
四、運行yapi
1. 搭建掛載配置文件
mkdir -p /data/yapi
vim config.json
{
"port": "3000",
"adminAccount": "wangzhenjun1221@163.com",
"timeout":120000,
"db": {
"servername": "mongo",
"DATABASE": "yapi",
"port": 27017,
"user": "yapi",
"pass": "yapi",
"authSource": ""
},
"mail": {
"enable": true,
"host": "smtp.gmail.com",
"port": 465,
"from": "*",
"auth": {
"user": "wangzhenjun1221@163.com",
"pass": "xxx"
}
}
}
:wq退出
2. 初始化資料庫表
docker run -d --rm \
--name yapi-init \
--link mongodb:mongo \
--net=yapi \
-v /data/yapi/config.json:/yapi/config.json \
yapipro/yapi \
server/install.js
3. 測試連接mongo
我們使用Navicat進行可視化的連接
資料庫輸入：admin
用戶名密碼都是剛剛配置的：yapi
連接成功！！
4. 運行yapi
docker run -d \
--name yapi \
--link mongodb:mongo \
--restart always \
--net=yapi \
-p 3000:3000 \
-v /data/yapi/config.json:/yapi/config.json \
yapipro/yapi \
server/app.js
5. 測試使用
ip:3000
//192.168.84.144:3000/
初始化管理員帳號在上面的 config.json 配置中adminAccount
初始化密碼就是：yapi.pro
6. 新建項目
7. 獲取token
五、Idea中使用
1. 下載插件
插件名稱：EasyYapi
2. 配置插件
3. 測試上傳
找到controller
選擇你要上傳的介面，點擊對號上傳！
填寫token
上傳成功：
六、在線請求使用
1. 配置地址
2. 配置地址
3. 安裝cross-request 插件
發送請求時，會提醒你安裝，你按照提示安裝下載即可！
也可以下載小編的：
鏈接：//pan.baidu.com/s/1Bx6nGFjKsQ3ajbnLPcjsSA
提取碼：gljt
直接解壓，拖拽到這裡就行！！
4. 點擊發送
測試完成！！
七、總結
總的來說搭建還是比較簡單，集成和使用也挺好用！非常推薦哈！！
小編辛辛苦苦寫了半天，看到這裡還不給小編點個關注！！謝謝大家
有緣人才可以看得到的哦！！！
歡迎關注小編的微信公眾號，謝謝大家！
