最近公司内部调整接口文档工具,将使用YApi用来定义前后端接口文档的交互沟通工具,公司使用的idea,为了缩短写文档的时间,将使用插件EasyApi来让我们减少些工作量,毕竟有些时候写文档也是个很耗时但又必须要要做的事情,下面我来介绍这些步骤。
1、默认已经打开了idea
2、安装插件并重启idea,这步就不详细介绍了。下图是我本地安装好了的
3.重启后,找到 File-Settings —>other Settings —>EasyApi
server:YAppi的服务地址
tokens:当前要生成的controller文件所在的项目的名称=YAppi上要导入项目的token
项目id获取方式:
项目token获取方式:
4.找到要导出接口文档的controller,右击找到 export,如下图
出现下图
第一次导出会有弹框弹出让输入项目id和token,按上面获取项目id和项目token方式获取到填入即可。
一般情况下,idea的控制台会输出
表示导出成功,到YApi对应的项目文档中就能看到接口说明了,如下图:
接口定义的越规范,导出的接口说明就越规范。
在EasyApi下的BuildInConfig中加入鉴权逻辑,使用下面的这种方式进行配置:
配置信息:
yapi.export.before=groovy:```
httpClient.request().url("http://172.31.3.22:30000/api/user/login_by_ldap")
.method("POST")
.contentType("application/json")
.body(["email":"yourname","password":"yourpwd"])
.call();
```
注意 ```不要丢了