YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
Windows 部署:
部署环境:window server 2012、node.js_v10.15、MongoDB_v4.0.5
安装选择版本建议选择 LTS 版,安装包建议选择二进制包 「.msi」
1.1、安装 npm ,新版本 node.js 默认集成 npm ,输入 npm -v ,如出现版本号则表示已安装
安装包建议选择二进制包 「.msi」 ,下载后安装,安装过程去掉勾选 “install mongoDB compass”,如下图
4、安装 YApi ,步骤教程 官网传送门>>
4.1、创建文件夹 yapi ,在 yapi 文件夹中打开命令行(cmd/终端),下载到本地
git clone https://github.com/YMFE/yapi.git vendors
4.2、复制配置文件到当前目录
cp vendors/config_example.json ./config.json
4.3、执行安装依赖
cd vendors
npm install --production --registry https://registry.npm.taobao.org
4.4、安装程序(初始化数据库和管理员账号),默认在 yapi 文件夹下面的 config.json 配置
注意:执行该步骤前确保 MongoDB 已成功安装并运行,并且已经创建了与 config.js 对应的数据库名称(默认数据库名称配置为 yapi )
npm run install-server
4.5、启动服务器,默认为 config.json 配置里面的端口
node server/app.js
安装后的目录大概这样:
└─yapi
├─config.json
├─init.lock
└─vendors
├─client
├─common
├─docs
├─exts
├─server
├─static
├─test
├─.eslintignore
├─.eslintrc.js
├─.gitignore
├─.npmrc
├─.package.json.swp
├─CHANGELOG.md
├─config_example.json
├─LICENSE
├─nodemon.json
├─package.json
├─plugin.json
├─README.md
├─webpack.alias.js
├─yapi-base-flow.jpg
├─ydoc.js
├─ydocfile.js
└─ykit.config.js
4.6、添加到系统启动项中
默认的,如果系统重启,这个就需要重新打开,很麻烦,所以,根据官方推荐,使用 pm2 管理 node 服务器启动
4.6.1、安装 pm2
npm install pm2@latest -g
4.6.2、在 vendors 中打开命令行,执行
pm2 start server/app.js --watch
完成!
备注1:创建 MongoDB 数据库,并创建对应用户
use yapi
db.createUser({user:'yapi',pwd:'123456',roles:[{role:'dbOwner',db:'yapi'}]})
备注2: config.json 默认配置
{
"port": "3000",
"adminAccount": "admin@admin.com",
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "yapi",
"pass": "123456",
"authSource": ""
},
"mail": {
"enable": true,
"host": "smtp.email.com",
"port": 465,
"from": "email",
"auth": {
"user": "email",
"pass": "pwd"
}
}
}