1.本地安装apifox客户端并登录
1)下载地址
https://apifox.com/?utm_source=baidu&utm_medium=sem&utm_campaign=352505605&utm_content=8777274745&utm_term=apifox%E5%AE%98%E7%BD%91%E5%85%A5%E5%8F%A3&bd_vid=8678844432097094883
2)登录
2.获取访问key
3.idea中下载apifox插件
4.配置访问key
5.配置具体要生成接口文档的项目到apifox以及冲突处理规则(这个规则是指如果一个controller层多次生成文档,那么该如何处理相同接口的文档)
6.导出接口到apifox
找到对应的controler接口,右键
7.接口测试(根据实际情况选择对应的环境,并配置访问项目的公共前缀(一般本地测试的话就配置协议+端口号+项目访问路径,如http://localhost:8080/application/))
8.配置全局参数和后置操作
1)全局参数
使用的情景:当我们的接口访问需要认证的时候,那么每次都需要携带token到请求头。如果要测试的接口数量很多,那每个接口都需要添加这个请求头,很耗时,也很麻烦。所以需要用到这个全局参数,配置了全局参数后,那么所有的接口,默认都会带上这个参数,如请求头参数。这时又有一个问题,如果这个全局参数是请求头,那么该怎么将值设置进去呢?我们可以用**{{变量名称}}** 做个占位操作。具体的复制我们可以通过后置操作进行。
2)后置操作
比如,我们有个登录接口,我们需要把登录接口返回的响应结果中的某一个参数传递给全局参数,那么我们可以按下述操作
第一个参数是变量名称,即我们上面设置的全局参数名称,第二个参数是我们要从返回结果中选取的值赋值给这个变量