YApi

YApi 部署

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。以及自动化生成接口文档。

附官网地址：https://hellosean1025.github.io/yapi/

环境要求

• nodejs（7.6+) http://nodejs.cn/download/ 选择系统下载，然后双击安装即可
• mongodb（2.6+）通过包管理工具进行安装，想要其他ip可访问，需要mongod —bind_ip_all
• git

有网络的情况下：

一：本地开发(可视化部署)

npm install -g yapi-cli --registry https://registry.npm.taobao.org  # 报错的话需要加上sudo
yapi server

此时，根据终端out的内容打开浏览器，一般是127.0.0.1:9090进行配置。等待配置完成之后，根据页面提示。

node my-yapi/vendors/server/app.js

开启服务.png

至此服务开启成功。访问127.0.0.1:3000进行注册登陆。用户名为刚才配置输入的邮箱地址，密码为ymfe.org。登陆系统可以修改。(想要暴力更换管理员，直接至mongodb数据库删除当前的用户，重新至页面注册，改role为admin就可以了。接下来服务已经可以使用)

注册页面.png

二：如何至内网无网络情况部署

本地部署完，即可以使用，想要部署到内网无网络情况。可以直接将my-yapi整个文件夹拷贝到内网服务器上，并且将本地mongodb的yapi整个数据导入至内网服务器中。此时依旧开启服务。依旧可用。

三：命令行部署

官网介绍的很详细：https://yapi.ymfe.org/devops/index.html # 此处直接贴官网内容

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录（clone 整个仓库大概 140+ M，可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少，大概 10+ M）
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

其他说明

想要能够真实的像postman样的发送请求，需要安装chrome插件，可至github进行下载安装：https://github.com/ymfe/yapi

配置文件位于my-yapi/config.json (每次更改完需要重新启动服务：推荐pm2进行)

"closeRegister":true  # 禁止用户注册
# 还可开通电子邮箱功能（下方介绍），以及官方推荐使用pm2进行管理node的服务

如何安装插件：

• dingding 钉钉机器人推送插件
• qsso sso 第三方登录
• import-rap 从rap中导入项目
• export-docx-data 数据导出docx文档

# 例：export-docx-data
npm install ykit -g  # 需要安装ykit
ykit  # 出现版本信息即可
yapi plugin -- name yapi-plugin-export-docx-data  # 安装插件，自动执行
# 在 my-yapi/vendors 文件下添加模版文件
https://github.com/inceptiongt/Yapi-plugin-export-docx-data/blob/master/input.docx

Yapi 邮箱邮件配置

修改 my-yapi/config.json 文件

vi my-yapi/config.json
"versionNotify": true,  # 版本变更通知
"mail": {
      "enable": true,
      "host": "smtp.qq.com",
      "port": 465,
      "from": "qq号@qq.com",
      "auth": {
         "user": "qq号@qq.com",
         "pass": "授权码"
      }
# 重启服务器

查看邮箱状态.png

# 授权码获取方式
qq邮箱 > 设置 > 账户 > POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务 > 开启 > 授权码

获取邮箱授权码.png

补充：

1:修改了源码之后，如何进行重新打包静态资源 —— 20191205

cd yapi/vendors
ykit pack -m   # 重新打包
node ./server/app.js   # 重新启动服务器
例子：
在测试集合中新增时间，只需修改InterfaceColContent.js文件中，新增up_time并且转换为时间格式，重新打包、重启服务器即可。