使用IDEA向YApi上传接口文档

一、在IDEA中安装YApi的插件

二、在IDEA中的misc.xml文件中添加如下代码：

<component name="yapi">
  <option name="projectToken">62819ad39e3b7e6eaf2696a7c22197d6b264eeebcd7e26f85a61a2ee5ae357a6</option>
  <option name="projectId">141</option>
  <option name="yapiUrl">http://192.168.101.154:3000</option>
  <option name="projectType">api</option>
  <option name="attachUploadUrl" />
</component>

三、登陆YApi页面

点击【设置】

 

可以获取：token: 62819ad39e3b7e6eaf2696a7c22197d6b264eeebcd7e26f85a61a2ee5ae357a6

                 项目ID: 141

然后：再次修改misc.xml文件，替换token和projectId

<component name="yapi">
  <option name="projectToken">62819ad39e3b7e6eaf2696a7c22197d6b264eeebcd7e26f85a61a2ee5ae357a6</option>
  <option name="projectId">141</option>
  <option name="yapiUrl">http://192.168.101.154:3000</option>
  <option name="projectType">api</option>
  <option name="attachUploadUrl" />
</component>

三、注释的写法

类上的注释：

/**
 *@description: 异动管理接口
 *@menu 异动管理
 */

方法上的注释：

/**
 * @description: 查看待办任务列表
 * @param: [WaitforTaskFiler]
 * @return [ResponData<PageResult<DisturbanceDTO>>]
 */

点击方法上，右键

上传到YApi上