学习产出:
1、首先,到apifox官网上下载
2、注册apifox。Apifox 是一个在线的接口文档管理工具,这一步主要是用来同步文档到项目中。支持下载桌面端或直接网页注册,并且创建一个项目。
3、配置令牌。需要将 Apifox Helper 和 Apifox 的项目进行关联,也就是通过访问令牌绑定。
- 打开 Apifox, 点击左侧【头像】–>【账号设置】–>【API 访问令牌】
- 点击【新建令牌】,填写令牌名称,点击【保存并生成令牌】。
4、复制令牌到 IDEA 中【Apifox Helper】配置项的 API 访问令牌中。同理,在 Apifox 中进入项目,【项目设置 --> 基本设置】,复制项目 ID 。
5、在IEDA中安装插件。打开你的 IDEA,点击 File -->Settings --> Plugins,输入 Apifox Helper。 点击安装,然后等待成功后重启 IDEA.
6、在 IDEA 中,点击 File–>Settings -->Other Settings,找到 Apifox Helper。 将访问令牌和项目 ID 粘贴到这里:
7、生成文档。打开需要上传的 Controller 文件,右键选择「 Upload to Apifox」。
8、查看。去 Apifox 项目中查看自动生成的文档。点击 Apifox 右上角的刷新图标。刚才在 IDEA 项目中的接口文档就已经在这里了