YApi-高效、易用、功能强大的可视化接口管理平台—部署篇

最新推荐文章于 2024-08-29 13:40:09 发布

chenggedian7759

最新推荐文章于 2024-08-29 13:40:09 发布

阅读量718

点赞数 1

文章标签：数据库操作系统移动开发

原文链接：https://my.oschina.net/u/3667677/blog/3010777

版权

YApi https://yapi.ymfe.org/ 是由去哪儿网移动架构组(简称YMFE，一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具，一个可本地部署的、打通前后端及QA的接口管理平台，YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布和维护不同项目，不同平台的API。有了YApi，我们可以很方便的测试、管理和维护多个项目的API接口，不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭)，YApi是一个独立的服务平台。

下面介绍windows下部署YApi接口管理平台的相关步骤。

内网部署

环境要求：

nodejs（7.6+)
mongodb（2.6+）

1.安装nodejs

nodejs官网 https://nodejs.org 下载安装包安装。

2.安装mongodb

MongoDB官网 https://www.mongodb.com/download-center/community 下载安装包安装。安装过程中会提示你安装图形界面管理工具MongoDB Compass，挺慢的，记得把√去掉，以后自己去官网下载安装。

3.安装YApi的部署脚手架

npm install -g yapi-cli
yapi server

效果如下图所示

按照提示打开地址 http://localhost:9090 按照提示部署，效果如下图所示

成功后根据提示访问：切换到部署目录，输入node vendors/server/app.js指令启动服务器，然后在浏览器打开 http://localhost:3000

管理员账号：hilanmiao@126.com 密码：ymfe.org

刚进来是空的，你需要创建一个项目,按照教程操作即可。 https://yapi.ymfe.org/documents/index.html

4.服务器管理

如果你使用node vendors/server/app.js指令启动服务器，那么当cmd窗口关闭时，node服务就关了，网站就打不开了。推荐使用 pm2 管理 node 服务器启动，停止，具体使用方法可参考官网的教程，我写个简单的。

记得用管理员身份打开CMD窗口

安装 pm2

npm i -g pm2

安装并配置 pm2-windows-service

pm2-windows-service可以将 pm2 安装成 windows service, 达到开机运行的目的

npm i -g pm2-windows-service

添加pm2环境变量

添加系统环境变量 PM2_HOME=D:\.pm2

右键 [我的电脑] - [属性] - [高级系统设置] - [环境变量] - 新建 [系统变量]

名称PM2_HOME 路径D:\.pm2（这路径根据自己需要定）

安装服务

以管理员权限打开新的命令行窗口,执行以下命令来安装服务

pm2-service-install

Perform environment setup ? 选 n, 继续

此时, PM2服务已安装成功并已启动, 可以通过 Wn+R来查看，输入services.msc即可看到服务

启动node程序

下面用 pm2 来启动我们自己的服务程序 app.js, 然后告诉 pm2 开机后自动运行我 app.js.继续在管理员命令行下, cd 切换到yapi的vendors/server/到 app.js 所在目录

pm2 start app.js --name yApi

查看服务列表

pm2 list

添加到自启动服务

pm2 save

pm2 save很重要, 它保存当前pm2 正在管理的NodeJS服务, 并在开机后恢复这些服务至此, 安装配置完成

卸载服务

pm2-service-uninstall

效果如下图所示：

5.结尾提示

服务器重启之后可能需要先启动Mongodb。

cd C:\Program Files\MongoDB\Server\4.0\bin

mongod.exe --config "C:\Program Files\MongoDB\Server\4.0\bin\mongod.cfg --install -serviceName "MongoDB"

net start MongoDB

pm2 restart all

现在命令已经添加到windows服务上了，以后只需要执行 net start MongoDB就可以启动Mongdb了。

现在你可以在浏览器打开 http://localhost:3000 管理你的api了。其他知识如邀请团队成员、pm2 启动停止等有需要的自己学一下就好了，拜拜。

转载于:https://my.oschina.net/u/3667677/blog/3010777