部署yapi踩坑

    YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

    github地址：https://github.com/YMFE/yapi

    示例站点：yapi.demo.qunar.com

    文档：hellosean1025.github.io/yapi

    二次开发遇到的问题：https://github.com/YMFE/yapi/issues/208

    主要配置文件：config.json、package.json

    开发环境：操作系统：win10，浏览器：chrome77，node版本：v10.16.3，npm版本：v6.12.0，mongodb版本：v4.0.10，yapi版本：1.8.3

 

1. 部署yapi

1.1 可视化部署

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

    执行yapi server启动可视化部署程序，打开指定url，输入相应的配置，点击开始部署，没报错的话就能完成yapi的部署。

 

1.2 从 github上clone项目部署

    除了可视化部署外，可以从github上clone项目，复制项目配置文件，启动安装程序，初始化配置文件

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 
node server/install.js

 

2. 运行yapi

    进入vendors目录，执行以下命令启动服务器

node server/app.js

    出现上图后，在浏览器打开指定url, 点击登录输入部署时设置的管理员邮箱，默认管理员是[email protected]，默认密码是ymfe.org。如果遇到无法连接上mongodb，则可以查看config.json配置是否正确，还可以查看mongo.config是否配置正确。

 

3. 启动开发环境

    启动开发环境前首先要执行：

npm install 

    执行这个命令时，npm会安装package.json配置文件中的包并将包存放于node_modules目录下，如果报错误则按相应的报错信息去解决。

    接下来，先启动服务端，如图所示则说明启动成功：

npm run dev-server

    再打开另外一个shell启动客户端：

npm run dev-client

    或者分别执行：

cp -r static/iconfont ./
ykit s -p 4000

    执行会完出现下图：

    然后在浏览器打开http://127.0.0.1:3000，ykit便会执行热更新，如下图所示：

    这样的话，修改完代码，分别执行npm run dev-server与ykit s -p 4000便能实现热更新，会显示修改后yapi。