window下部署Yapi接口管理系统部署总结

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

1、本地已经装好docker环境

2、Docker安装MongoDB数据库

#在合适的目录下新建mongoDB存储文件夹（我在D:\environment\Yapi\data\mongo）
#拉取MongoDB镜像
docker pull mongo:4.2.21
#启动MongoDB容器
docker run -d --name mongodb --restart always  -p 2717:27017-v D:/environment/Yapi/data/mongo:/data/db -e MONGO_INITDB_DATABASE=yapi -e MONGO_INITDB_ROOT_USERNAME=yapipro -e MONGO_INITDB_ROOT_PASSWORD=yapi2023 mongo:4.2.21
#进入mongo容器
docker exec -it mongodb /bin/bash
#进入mongo客户端
mongo localhost:27017
#初始化数据库,依次执行下面的命令
use admin;
db.auth("yapipro", "yapi2023");
#创建yapi数据库
use yapi;
# 创建给yapi使用的账号和密码，授予可操作的权限
db.createUser({
  user: 'yapi',
  pwd: 'yapi123456',
  roles: [
 { role: "dbAdmin", db: "yapi" },
 { role: "readWrite", db: "yapi" }
  ]
});
# 退出mongo客户端
exit
#退出mongo容器
exit

3、Docker安装Yapi

1、创建合适的地址创建yapi的配置文件config.json（D:\environment\Yapi\data\config）

在这里插入图片描述
内容如下（更具自己改一下）：

{
   "port": "3000",
   "adminAccount": "yapiadmin@163.com",
   "timeout":120000,
   "db": {
     "servername": "mongo",
     "DATABASE": "yapi",
     "port": 27017,
     "user": "yapi",
     "pass": "yapi123456",
     "authSource": ""
   },
   "mail": {
     "enable": true,
     "host": "smtp.163.com",
     "port": 465,
     "from": "*",
     "auth": {
       "user": "yapiadmin@163.com",
       "pass": "yapiadminpassword"
     }
   }
 }

2、安装Yapi

#拉球Yapi镜像
docker pull yapipro/yapi:1.9.5
#初始化数据库表
docker run -d --rm --name yapi-init --link mongodb:mongo -v D:/environment/Yapi/data/config:/yapi/config.json yapipro/yapi:1.9.5 server/install.js

#启动yapi容器
docker run -d --name yapi --link mongodb:mongo --restart always -p 3000:3000 -v D:/environment/Yapi/data/config:/yapi/config.json yapipro/yapi:1.9.5 server/app.js

4. 访问Yapi

地址：http://localhsot:3000

账号在上面的 config.json 配置中 adminAccount的值;
初始密码: yapi.pro
在这里插入图片描述

5、从本地导入接口

1、在ider上安装easyYapi插件，安装后重启；
在这里插入图片描述
2、idea依次点击File-》setting-》other setting -》EasyApi

依次填写Yapi项目地址和token；
token的获取(新建项目依次点击设置-》token配置)

3、导入接口（找到contraller,右键依次点击后，在yapi上会看到接口）