Yapi-从零搭建接口管理平台

介绍

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

官网网址：YApi-教程 (hellosean1025.github.io)

搭建

其实官网有明确的搭建方法，而且都是中文的。本篇文章就相当于复习了。

首先，准备搭建环境：nodejs、mongodb；

官网介绍了，搭建方法共两种（如果网速不好不建议用第一种，那叫一个慢呀）：

• 第一种部署方式

#在linux输入命令：

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

执行完成后，访问 Ip:9090，在弹出的页面中进行可视化配置，时间有点长，请您耐心等候：

• 第二种部署方式

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors 
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配置的端口}，初次运行会有个编译的过程，请耐心等候

后台运行

node需要安装pm2模块，使用pm2模块后台运行yapi。

npm install -g pm2

cd /usr/local/yapi/vendors

pm2 start server/app.js

其他配置

• 禁止注册

在 config.json 添加 closeRegister:true 配置项,就可以禁止用户注册 yapi 平台，修改完成后，请重启 yapi 服务器。

{
  "port": "*****",
  "closeRegister":true
}

• 添加钉钉通知插件

cd /usr/local/yapi

yapi plugin --name yapi-plugin-dingding
#执行上面命令如果报需要安装ykit，优先执行下面命令在重新执行上面的命令即可
npm i ykit -g
#安装完成后，修改config
{
  
   "mail": {
      "enable": false,
      "host": "smtp.163.com",
      "port": 465,
      "from": "***@163.com",
      "auth": {
         "user": "***@163.com",
         "pass": "*****"
      }
   },
   "plugins": [
      {
         "name": "dingding",
         "options": {
             "host": "http://127.0.0.1:9191"
         }
      }
   ]
}
#最后重启