一、前言

在我們后端開發中，必不可少的是接口的交接，有很多種方式，常見的就是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

1、創建網絡

docker network create yapi

2、創建掛載文件

mkdir -p /data/mongo

3、運行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 用戶密碼。

4、進入容器初始化數據庫

進入 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。

連接成功?。?/p>

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:3000http://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 插件

發送請求時，會提醒你安裝，你按照提示安裝下載即可！

也可以下載小編的：

鏈接：https://pan.baidu.com/s/1Bx6nGFjKsQ3ajbnLPcjsSA 提取碼：gljt。

直接解壓，拖拽到這里就行！

4、點擊發送

測試完成?。?/p>

七、總結

總的來說搭建還是比較簡單，集成和使用也挺好用！非常推薦哈！