ApiFox接口文档的使用

前言

• 我们都知道，现在业界基本上都是前后端分离的架构，前端人员和后端人员同步进行着自己的工作，那么前端人员怎么知道要调用后端哪些接口呢，这些接口的参数是什么呢，请求的方式又是什么呢，等等问题都需要前后端人员协调好，不可能做一个功能问一下吧，这显然是提高不了工作效率的，还可能因为传达信息不明确而做无用的工作，所以我们需要一个文档，来告诉前端开发人员到底有哪些接口，接口的参数是什么，请求方式是什么。
• 但是写这样一个文档又是一件很费时间的事儿，所以ApiFox就能帮助我们生成需要的接口文档，只需要在接口上加上相应的注释，对代码0入侵，使用起来也超级方便。

APiFox创建接口文档

• 【第一步】安装 Apifox IDEA 插件（Apifox Helper）
  File > Setting > Plugins ，搜索Apifox Helper ，点击install即可，下图是下载后的界面
  
  下载成功后，在类中右键就会出现Apifox的标志
  
  【第二步】配置访问令牌和项目id
• Apifox可以下载，也可以使用网页版本，我使用的是网页版
• 进入Apifox，注册并登录
• 在个人中心，点击新建项目按钮，选择项目类型，填写项目名称，选择项目语言，点击新建即可
  
  点击左下角的头像 >账号设置
  
  选择API访问令牌，点击新建，填写令牌名称和有效期（可以按需选择），点击保存并生成令牌
  
  此时会生成一个字符串令牌，请妥善保管，复制到一个地方保存起来，窗口关闭便不可见。
  
  【第三步】复制项目id
• 点击项目设置，复制项目id,和上一步的令牌保存在一起
  
  【第四步】idea项目绑定APifox项目
• 在idea中，点击File > Setting >ApiFox Helper，将令牌和项目id分别赋值到如下位置，项目id前是你的项目名称（要是英文的，不是apifox中的项目名）
  
  【第五步】编写注释
• 注释里面的 @param, @link, @return 这些就是标准的 Javadoc 注释，在 JDK 里定义好的，只需要在接口上加上注释即可
  
  【第六步】生成接口文档
• 在idea中，右键 Upload To FireFox，即可看到控制台的输出信息，由此打了注释的接口便生成了接口文档
  
  控制台输出的结果如下
  
  打开Apifox接口管理，就可以看到生成的接口，至此便可以使用了
  
  【第七步】邀请成员
• 点击邀请成员，设置成员的权限，点击复制，将链接发送给需要查看文档的成员即可
  
  【第八步】成员加入项目
• 成员收到邀请，点击链接，进入如下界面
  
• 点击加入项目即可看到所有的接口文档信息