IDEA开发工具整合YAPI接口平台

1 前提

1 前提

1.1 代码规范

良好的代码书写和注释习惯
类、方法、类的属性上需要添加注释

1.2 注释模板需统一

1.2.1 类注释demo

/**
 *  @Description:
 *  @author: niwenhua
 *  @Date: $Date$ $time$
*  @menu 数据集
 */

menu对应YAPI中的分类名称，如下图

1.2.2 方法注释样本

/**
 * @Description:    $description$
 * @Author:         作者姓名
 * @UpdateUser:     更新人姓名
 * @Param: $param$
 * @Return: $return$
 * @CreateDate:     $date$ $time$
 * @UpdateDate:     $date$ $time$
 * @version:        1.0
 * @status:         done
 */

status用于YAPI中对应接口完成状态，分为3种，已发布(done),设计中(design),开发中(undone),已提测(testing),已过时(deprecated),暂停开发(stoping)，新增接口默认开发中。

1.2.3 类属性注释样本

/** 
* 名称
*/
private string name;

2 使用YapiUpload插件

2.1 下载YapiUpload插件

在File>settings>plugins >BrowseRespositories>YapiUpload插件

2.2 配置

找到idea项目所在盘符打开.idea文件
打开misc.xml

在misc.xml中添加以下内容（单工程加入以下内容，示例是单体工程）

<component name="yapi">
    <option name="projectToken">23bb9bf631XXXXXXXXXXXXXXXXXXXXXXXX</option>
    <option name="projectId">89</option>
    <option name="yapiUrl">http://ip:端口号</option>
    <option name="projectType">api</option>
  </component>

符合工程的配置

  <component name="yapi">
    <option name="moduleList">moduleName1,moduleName2</option>
  </component>

  <component name="moduleName1">
	<option name="moduleName1.projectToken">yapi 中项目token</option>
	<option name="moduleName1.projectId">yapi 中项目id</option>
	<option name="moduleName1.yapiUrl">http://ip:端口号</option>
	<option name="moduleName1.projectType">api</option>
	<option name="moduleName1.returnClass">com.project.Response</option>
  </component>
  
  <component name="moduleName2">
    <option name="moduleName2.projectToken">yapi 中项目token</option>
    <option name="moduleName2.projectId">yapi 中项目id</option>
    <option name="moduleName2.yapiUrl">http://ip:端口号</option>
    <option name="moduleName2.projectType">api</option>
    <option name="moduleName2.returnClass">com.project.Response</option>
  </component>