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

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

目录

1    前提    

1.1    代码规范

1.2    注释模板需统一

2    使用YapiUpload插件    

2.1    下载YapiUpload插件    

​2.2    配置

2.3    idea代码中添加注释

​2.4    idea推送到YAPI    

3    使用EasyYApi插件 

3.1    下载EasyYApi插件    

​3.2    配置    

​3.3    测试接口

​3.4    idea推送到YAPI    

4    总结    

5    插件文档    

---

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