使用IDEA插件生成YaPi接口文档+Windows环境搭建YaPi服务_idea yapi插件

使用IDEA插件生成YaPi接口文档+Windows环境搭建YaPi服务

【注意1：使用idea插件生成yapi文档之前，需要搭建yapi服务】

【注意2：本文章是在windows本机搭建yapi服务】

【注意3：下面软件安装的版本最好与我保持一致，高版本的node会和mongo不兼容】

废话少说，开始安排！

1，安装node12：

下载：

安装包链接：https://nodejs.org/download/release/v12.18.3/
1

​ 选择这个版本，点击下载即可：

安装：【基本上都是下一步】

①双击安装包，直接安装：下一步

​ ②自定义安装目录：【目录最好不要用中文】

​ ③直接下一步：

​ ④不要勾选，直接下一步：

​ ⑤点击“install”进行安装：

​ ⑥安装完成，点击“finish”：

检查【注意：node会自动配置环境变量】

#使用快捷键“win+r”，输入“cmd”调出命令行窗口，在窗口中输入以下指令：
# node版本
node -v  
# npm版本
npm -v 
1
2
3
4
5

如图：安装成功

安装淘宝镜像：

#在命令行中输入以下指令：
#安装淘宝镜像：
npm config set registry https://registry.npm.taobao.org
#检查是否成功：
npm config get registry
1
2
3
4
5

如图：安装成功：

2，安装mongo4：

下载

mongo官网链接：https://www.mongodb.com/try/download/community
1

如图：【首次安装可能会需要注册账号，按照指示注册即可】

安装：【基本上都是下一步】

①双击安装包，直接安装：下一步

②下一步：

③点击“custom”，下一步

④自定义安装目录：【最好不要有中文】

⑤确认目录，下一步：

⑥直接下一步：

⑦取消勾选，下一步：

⑧安装成功：

配置环境变量：

Step1：此电脑（鼠标右键点击）–>属性–>高级系统设置–>环境变量

Step2：新建系统变量–>path变量

复制粘贴mongo的安装目录下的bin目录：

检查：

命令：mongo -version
1

如图：安装成功

启动：

在安装目录下\data\创建一个db目录，作为安装目录\data\的备用目录，显式指定该目录为存储位置

#指令
mongod.exe --dbpath "你的MongoDB安装目录\data\db"
1
2

如图：

验证是否启动成功：

#浏览器访问：
http://localhost:27017/
1
2

如图：启动成功

3，安装Yapi：

npm安装：注意，这一步只需要执行这一次，以后再次启动yapi服务可直接跳过这一步

#在命令行中输入以下指令：
#安装
npm install -g yapi-cli --registry https://registry.npm.taobao.org
#启动：
yapi server
1
2
3
4
5

如图：

验证：

#浏览器访问：
localhost:9090
1
2

如图：启动成功

详解：

部署成功：

启动Yapi服务：

#进入刚才的部署目录，以管理员的身份运行命令提示符：
cd C:\Windows\System32\my-yapi
#启动
node vendors/server/app.js
1
2
3
4

如图：启动成功

校验：

#浏览器访问：
http://localhost:3000
#默认用户名：刚才设置的邮箱 默认密码：ymfe.org
1
2
3

如图：

新建项目：

登录进去之后，需要创建一个项目：

项目信息：可以自定义

创建完成后：

点击进去项目：注意这个token的位置

4，idea中安装插件并配置Yapi服务：

安装插件：EazyYapi 【首次安装需要重启idea】

配置Yapi服务：

生成接口文档：选择需要生成接口文档的controller接口类：右键

【前提是controller类中必须有已经写好的接口方法】

填写项目的token：

在idea控制台看到这一行信息，就表示成功了：

Yapi服务查看：【同一个controller类对应一个文件夹，右边是该类中的所有接口方法】

导出接口文档：

导出之后就是一个文件：比如html格式的文件

点开：右边是目录，左边是接口详情（包括接口名，请求方式，请求路径，请求参数，返回值等）

同样的，也可以将指定类型文件导入进去，这里不再演示；

到此，本次文章结束。。。。