Yapi安装部署（接口管理服务）

水深无声 2023-01-01 01:54 237阅读 0赞

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

官方文档：[https://hellosean1025.github.io/yapi/devops/index.html][https_hellosean1025.github.io_yapi_devops_index.html]

![yapi界面][yapi]

## 环境要求 ##

*  nodejs（7.6+)
 *  mongodb（2.6+）

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

下载链接：[Node v12.12.0/ (nodejs.org)][Node v12.12.0_ _nodejs.org]

**安装MongoDB注意：** 选择 Custom：自定义安装路径。安装MongDB需要取消这个勾选，不然会死等…（剩下一路next）

![install mongodb][]

下载链接：[Downloads for win32 (mongodb.org)][Downloads for win32 _mongodb.org]

### 配置Node淘宝源 ###

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

### 配置MongoDB ###

![mongodb config][]

在安装目录创建 `mongodb.config`，填入如下信息（需要修改安装目录：我安装在：`D:\MongoDB`）

# 修改安装目录
    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命令窗口输入如下命令

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

打开浏览器访问 [http://localhost:27017/][http_localhost_27017] 或者 [http://127.0.0.1:27017/][http_127.0.0.1_27017]

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

![mongodb success][]

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

![添加系统变量][0dcffcc9659f58d214f397b97523d3d8.png]

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

D:\MongoDB\bin

*  之后可以在cmd里输入mongo测试一下

## 安装yapi ##

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

### 启动yapi ###

# 启动
    yapi server

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

需要用本机IP进入，可以用如下方法查询查询本机IP，找到之后复制即可:

# 找到无线局域网适配器 WLAN
    ipconfig

启动后会显示一个网址，进入该网址，如下界面：

![yapi平台部署][yapi 1]

填写完信息后，点击开始部署，需要记住这个**部署路径**

成功部署后会显示如下：

![部署成功][ba18016e82be1ee5509df609a6bc362f.png]

进入**部署路径**，输入如下命令

# 切换到部署路径下启动
    node vendors/server/app.js

内网下可以通过本机IP+端口号，进行访问

### pm2方式管理进程 ###

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

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

![pm2启动][pm2]

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

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

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

[https_hellosean1025.github.io_yapi_devops_index.html]: https://hellosean1025.github.io/yapi/devops/index.html
[yapi]: /images/20221120/89a670ee177b42079d09fb94c985d3e4.png
[Node v12.12.0_ _nodejs.org]: https://nodejs.org/download/release/v12.12.0/
[install mongodb]: /images/20221120/5cd441b407fc420490bf8ca009712baa.png
[Downloads for win32 _mongodb.org]: http://dl.mongodb.org/dl/win32/x86_64
[mongodb config]: https://img-blog.csdnimg.cn/img_convert/13fc60d1178f3d1ea21295dc63203bf3.png
[http_localhost_27017]: http://localhost:27017/
[http_127.0.0.1_27017]: http://127.0.0.1:27017/
[mongodb success]: https://img-blog.csdnimg.cn/img_convert/511d310cfd2f1879ee18476bc387eeba.png
[0dcffcc9659f58d214f397b97523d3d8.png]: https://img-blog.csdnimg.cn/img_convert/0dcffcc9659f58d214f397b97523d3d8.png
[yapi 1]: https://img-blog.csdnimg.cn/img_convert/9a989b2335543a708809f5c570b84b06.png
[ba18016e82be1ee5509df609a6bc362f.png]: https://img-blog.csdnimg.cn/img_convert/ba18016e82be1ee5509df609a6bc362f.png
[pm2]: https://img-blog.csdnimg.cn/img_convert/e90000d458b3abbd832fb28435d9c654.png