YAPI部署及使用文档

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

1.部署

所需环境：node.js+mongodb+yapi

1.1 安装node.js（7.6+）

使用淘宝镜像源下载包

wget https://npm.taobao.org/mirrors/node/v12.12.0/node-v12.12.0-linux-x64.tar.gz

解压并重命名

tar -xvf node-v12.12.0-linux-x64.tar.gz
mv node-v12.12.0-linux-x64.tar.gz node

加入变量
```
sudo vim /etc/profile
```

添加以下内容后保存并退出

# node.js
export NODE_HOME=<node文件夹路径>
export PATH=$NODE_HOME/bin:$PATH

刷新
```
source /etc/profile
```
测试
```
node -v
npm -v
```

1.2 安装mongodb（2.6+）

使用淘宝镜像源下载包

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-5.0.3.tgz

解压并重命名

tar -xvf mongodb-linux-x86_64-rhel70-5.0.3.tgz
mv mongodb-linux-x86_64-rhel70-5.0.3.tgz mongodb

加入变量
```
sudo vim /etc/profile
```

添加以下内容后保存并退出

# mongodb
export PATH=<MongoDB 的文件夹路径>/bin:$PATH

刷新
```
source /etc/profile
```

进入MongoDB 的文件夹路径创建必要文件夹 db 和 log，并修改其权限

cd <MongoDB 的文件夹路径>
mkdir db && mkdir log
chmod 777 db && chmod 777 log

创建配置文件

touch mongodb.conf
cd log && touch mongodb.log

修改配置文件

vim /<mongodb目录地址>/mongodb.conf

加入一下内容

port=27017                                     #服务的端口号
dbpath=<MongoDB 的文件夹路径>/db                #数据库存文件存放目录
logpath=<MongoDB 的文件夹路径>/log/mongodb.log  #日志文件存放路径
logappend=true                                 #使用追加的方式写日志
fork=true                                      #以守护进程的方式运行，创建服务器进程
maxConns=100                                   #最大同时连接数
journal=true                                   #每次写入会记录一条操作日志（通过journal可以重新构造出写入的数据）。 即使宕机，启动时wiredtiger会先将数据恢复到最近一次的checkpoint点，然后重放后续的journal日志来恢复。
storageEngine=wiredTiger                       #存储引擎有mmapv1、wiretiger、mongorocks
bind_ip=0.0.0.0                                #设置0.0.0.0外网才可以访问
auth=false                                     #校验权限，这是为 true yapi 会链接不上

启动 ,出现started successfully…即为成功

# mongod --config /<mongodb目录地址>/mongodb.conf
mongod --config /usr/local/mongodb/mongodb.conf

1.3 安装yapi （官方安装文档地址）

官方推荐使用可视化安装，以下也使用以下方法

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

使用浏览器登录：IP:9090
填写完成点击开始部署，命令行出现以下即表示完成

要保证后台保持进程，需要安装pm2

npm install pm2 -g  //安装pm2
cd  {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

出现以上则表示安装成功，访问 IP:3000，使用初始化账号密码进行登录

超级管理员账号：admin@admin.com
超级管理员密码： ymfe.org

2.使用

2.1 登录与注册

超级管理员拥有最高权限，可进行用户管理、查看系统信息、删除分组等（角色分为超级管理员>组长>开发者>访客）

2.2 注册成功后进入首页

每个人都可以创建分组，但只有超级管理员可以删除分组。

每个人都可以创建项目，但只有超级管理员和分组组长可以删除项目。

每个人都可以创建私有分组和项目，拥有完全的管理权限。

个人空间里的内容其它成员无法查看，可自行添加分组及项目
添加分组之后可设置允许查看该分组的成员列表，
查看分组动态

2.3 创建项目

2.4 idea集成生成Api接口

idea下载插件EasyYapi
安装完成后重启Idea
打开Idea => Settings => Other Settings => EasyApi 设置Yapi的服务地址

找到对应的需要创建或者更新的controller，鼠标右键，单击Export Yapi,第一次执行Export Yapi 会弹出一个框让我们输入Token,在自己创建的项目中找到设置 => token配置面板获取 Token

至此idea接口就一键同步到了 YApi

以后如果controller中接口有变动则再次执行Export Yapi如果controller中有多个接口，我们只想更新其中某一个接口，则鼠标右键Export Api选择要更新的接口

测试接口（可使用mock自动生成模拟数据）

2.5 Swagger方式导入接口

url导入方式很慢，不推荐使用，推荐使用swagger数据导入方式

导入方法：打开swagger文档 -> 点击链接打开文件，另存为jsom文件即可

2.6 测试

使用Mock代替后端的地址进行测试
- 在编辑中添加返回的Mock数据

在预览中复制Mock地址

替换前端中的后台接口地址进行测试

后续只需要替换Mock地址为实际的接口地址即可。
自动化测试

详见文档

服务端自动化测试