使用IDEA中的Yapi插件生成接口文档的简化使用

使用IDEA中的Yapi插件生成接口文档的简化使用

问题：之前手动搭建了Yapi服务，但是最近在使用的时候，突然发现之前部署Yapi服务的默认账号不能使用了，一登陆就警告“该用户不存在”。以为是Yapi服务的问题，测试之后，发现只是这个临时账号过期了。我能想到的解决方式有三种：第一种就是需要重新从头搭建Yapi服务，过程中可能还会需要重新安装node和mongo，具体步骤，可以参考之前的文章内容：

链接: https://blog.csdn.net/qq_53253335/article/details/134218099

第二种方式：手动注册个Yapi服务账号：

注意：以下命令是在之前搭建Yapi服务之后才能用
①启动mongo：

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

如图：

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

如图：

②启动Yapi服务

#以管理员的身份进入Yapi部署目录
cd C:\Windows\System32\my-yapi
#启动
node vendors/server/app.js

如图：

#访问地址：
127.0.0.1:3000

如图，选择注册，输入信息（其他信息随便，但是邮箱最好为自己真实的邮箱）

进去之后，按照原来的步骤，创建项目即可；
③配置IDEA中Yapi插件：

④选择controller类右键生成yapi文档，或直接右键controller所在的包，一次性生成所有的接口：

弹筐里输入新建项目的token：token在项目中的token设置中，复制即可

第三种方式：和上面的方式类似，是直接在Yapi的官网上注册一个账号，登录之后创建项目，对应的IDEA中Yapi插件配置改成Yapi官网地址即可；

对比：第三种方式，虽然使用起来比较方便，但是由于Yapi官网是面向所有用户的，所以有时候网络延迟会比较明显；第二种方式，是需要自己手动搭建的，只会对自己和指定自己ip的用户开放，所以基本上不会存在延迟。

IDEA中除了Yapi的插件可以生成接口文档外，还有Apifox的插件也能实现一键生成接口文档的功能，相关操作比较简单，搜索相关教程即可。但是ApiFox生成的接口文档还是不够成熟，接口文档的风格，本人还是用不习惯，没有Yapi文档那么一目了然。。。当然，仁者见仁智者见智，这只是个人习惯，勿喷。。。