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

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值