windows 下安装YApi及集成Idea的YapiUpload

一准备工具

• Mongodb

• Node和npm

二文档地址

https://hellosean1025.github.io/yapi/

三安装步骤

1.安装Mongodb，请参考

2.安装Node,请参考

3.安装YApi

1）YApi介绍

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。以及自动化生成接口文档。

2）本地开发(可视化部署) 有网络要求的情况下

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

3. 运行yapi的配置服务

yapi server

4.配置安装信息

完成提示浏览器打开127.0.0.1:9090进行yapi配置。等待配置完成之后，根据页面提示。

5.启动yapi服务

根据提示在yapi本地安装路径下找到D:\file\install\yapi\vendors\server\目录下,此目录下打开cmd 输入命令

node app.js

根据提示打开127.0.0.1:3000即可使用。（3000端口尽量留给它）

6. 使用pm2进行服务管理

如果使用node vendors/server/app.js启动Yapi服务的话，如果我们把cmd窗口关闭了，这时候我们就无法访问Yapi了，这时候我们就可以使用 pm2 管理 node 服务器启动，停止

1：安装pm2

npm i -g pm2

2：pm2管理yapi服务

进入Yapi的部署目录执行

pm2 start"vendors/server/app.js" --name yapi

如下表示成功：

这时候我们就可以使用pm2来管理yapi了

pm2操作Yapi基本命令：

   pm2 info yapi //查看服务信息

   pm2 start yapi //启动服务

   pm2 stop yapi //停止服务

   pm2 restart yapi //重启服务

   pm2 delete yapi //删除服务

pm2使用参考：https://blog.csdn.net/dreamer2020/article/details/53576382

7.默认账户密码

账号：admin@admin.com（配置时修改的账号）

密码：ymfe.org

 

五 IDEA集成YapiUpload接口管理配置

1.插件里搜索下载YapiUpload

首先打开idea界面，然后 按住快捷键ctrl+shift+a然后输入plugins,这个是插件安装的意思，然后我们选择这个plugins然后回车进入插件安装界面。搜索YapiUpload，并按照YapiUpload

2. 在项目中的.idea文件中，找到misc.xml文件

3. 打开misc.xml文件，在代码中添加如下配置

<!--yapi配置-->
<component name="yapi">
    <option name="projectToken">你的YApi对应项目的token</option>
    <option name="projectId">你的YApi对应项目的项目Id</option>
    <option name="yapiUrl">YApi的url</option>
    <option name="projectType">项目类型</option>
</component>

1) projectToken：来源，如下图

2) projectId：来源，如下图

3) yapiUrl：项目部署的ip加端口，我的是http://127.0.0.1:3000/

 

4) 测试上传接口，如下图，选中方法名，点击右键，选择UploadToYapi,执行之后，上传接口

接口上传成功日志

上传成功之后，在该项目下，可以看到已经生成的接口可以了