0%

Yapi安装部署(接口管理服务)

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

官方文档:https://hellosean1025.github.io/yapi/devops/index.html

yapi界面

环境要求

  • nodejs(7.6+)
  • mongodb(2.6+)

安装Node注意: 最好安装14版本之前的,推荐12版本的,不然可能Node版本过高,导致无法成功部署

下载链接:Node v12.12.0/ (nodejs.org)

安装MongoDB注意: 选择 Custom:自定义安装路径。安装MongDB需要取消这个勾选,不然会死等…(剩下一路next)

install mongodb

下载链接:Downloads for win32 (mongodb.org)

配置Node淘宝源

1
npm config set registry https://registry.npm.taobao.org

配置MongoDB

mongodb config

在安装目录创建 mongodb.config,填入如下信息(需要修改安装目录:我安装在:D:\MongoDB

1
2
3
4
5
6
7
8
9
10
11
12
# 修改安装目录
dbpath=D:\MongoDB\data\db # 数据库路径
# 修改安装目录
logpath=D:\MongoDB\log\mongod.log #日志输出文件路径

logappend=true # 错误日志采用追加模式

journal=true #启用日志文件,默认启用

quiet=true #过滤掉无用的日志信息,若需要调试使用请设置为false

port=27017 #端口号 默认为27017
  • 在 data 文件夹中新建文件夹 db
  • 在 log文 件夹中新建 logs文件夹,logs文件夹新建 log.txt

在MongoDB文件夹的bin目录下,启动cmd命令窗口输入如下命令

1
2
3
cd D:/MongoDB
# 修改安装目录
mongod --dbpath "D:\MongoDB\data\db" --logpath "D:\MongoDB\logs\log.txt" --install -serviceName "MongoDB"

打开浏览器访问 http://localhost:27017/ 或者 http://127.0.0.1:27017/

显示如下信息:说明启动成功

mongodb success

  • 右击“我的电脑”->属性->高级系统设置->环境变量

添加系统变量

新增你的 MongoDB 的 bin 目录的路径->保存

1
2
# 修改安装目录,我的安装在D盘
D:\MongoDB\bin
  • 之后可以在cmd里输入mongo测试一下

安装yapi

1
2
3
npm install -g yapi-cli
# 或使用淘宝源安装
npm install -g yapi-cli --registry https://registry.npm.taobao.org

启动yapi

1
2
# 启动
yapi server

yapi server 执行后提示:在浏览器打开 http://0.0.0.0:9090 访问。非本地服务器,请将 0.0.0.0 替换成指定的域名或你本机IP

在CMD中,可以用如下方法查询查询本机IP:

1
2
# 找到无线局域网适配器 WLAN
ipconfig
  • 找到后,输入ip+:9090,进入网址即可,界面如下:

yapi平台部署

填写完信息后,点击开始部署。注意:需要记住这个部署路径

成功部署后会显示如下:

部署成功

进入部署路径,输入如下命令:

1
2
# 切换到部署路径下启动
node vendors/server/app.js
  • 内网下可以通过本机IP+端口号,进行访问,界面如图:

    yapi界面

pm2方式管理进程

要保证后台保持进程,需要安装pm2,进入部署路径启动即可

1
2
3
npm install -g pm2
# 切换到部署路径下启动
pm2 start vendors/server/app.js --watch -i 1

pm2启动

这样以后就可以很方便的用pm2启动关闭就行了

1
2
3
4
5
6
# 启动
pm2 start vendors/server/app.js --watch -i 1
# 查看
pm2 list
# 停止
pm2 stop vendors/server/app.js

以后访问本机IP+端口号即可进入