IDEA中使用Apifox插件快速生成API接口文档

目录

一、在Apifox中创建项目

二、生成API访问令牌

三、IDEA安装Apifox Helper插件

四、设置Apifox Helper

五、在Controller中添加Swagger注解

六、生成API接口文档

---

一、在Apifox中创建项目

1.打开Apifox，官网：https://apifox.com/；

2.登录后，点击左边我的团队下的新建团队；

3.输入团队名称后创建一个新团队；

4.在新创建的团队中点击新建项目；

5.创建一个HTTP项目；

二、生成API访问令牌

1.网站登录后，点击右上角头像，点击账号设置；

2.点击左侧的API访问令牌；

3.然后点击新建令牌；

4.给令牌起名并设置有效期；

5.然后点击按钮就可以生成一个令牌了，需要注意的是一旦关闭弹框，就没有办法再次查看令牌了，所以需要将令牌保存好；

三、IDEA安装Apifox Helper插件

1.打开IDEA；

2.点击File -> 点击Settings...；

3.在设置中点击Plugins，在Plugins中搜索ApifoxHelper插件安装；

4.安装完成后需要重启IDEA；

四、设置Apifox Helper

1.点击File -> 点击Settings...打开设置；

2.点击Apifox Helper下的上传，分别设置API访问令牌以及代码模块与Apifox项目的对应关系；

3.API访问令牌使用步骤二中生成的，然后点击测试令牌，测试成功后，点击下方+号就可以设置代码模块与Apifox项目的对应关系了；

4.点击代码模块右边下箭头选择代码模块；

5.在下方接口中选择步骤一中创建的测试项目；

6.选择完成后，点击Apply应用设置就可以了；

五、在Controller中添加Swagger注解

1.在类上添加@Api(tags = "类功能的解释")；

2.在方法上添加@ApiOperation("方法功能的解释")；

3.测试代码如下：

@Api(tags = "测试接口")
@RequestMapping("/test")
@RestController
public class TestController {
    @ApiOperation("列表测试接口")
    @GetMapping("/list")
    public AjaxResult list() {
        return AjaxResult.success("测试成功");
    }
}

六、生成API接口文档

1.在步骤五的Controller中右击鼠标，点击Upload to Apifox，就可以生成API接口文档了；

2.Apifox中的文档如下；

3.需要注意的是，如果不在Controller中使用Swagger注解的注解，上面框住的地方就会显示类名和方法名，不利于阅读，如下；