YApi的在IDEA中的使用

1 IDEA中插件下载

2 misc.xml的配置

  <component name="yapi">
    <option name="projectToken">XXXXXXXXXX</option>
    <option name="projectId">47</option>
    <option name="yapiUrl">http://XXXX:3000</option>
    <option name="projectType">api</option>
    <option name="returnClass">com.easted.entity.CommonResponse</option>
  </component>

返回值自己根据统一的结果类型来自定义。

3 注释模板的配置

3.1 类注释

/**
 * 
 * @description: 
 * @menu 
 * @author wuk
 * @date ${DATE} ${TIME}
 */

3.2 方法注释

具体模板如下：

**
 * @Author wuk 
 * @Description TODO $end$
 * @Date  $date$ $time$
 * @status done
 $param$
 * @return $return$
 */

点击编辑

param的值如下：

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

4 具体的使用

先打出/*然后使用Tab键引出，即可。

Controller层使用
实体类使用