idea集成插件YapiUpload

接口信息导入yapi插件

https://github.com/diwand/YapiIdeaUploadPlugin/wiki/快速使用

YapiUpload与项目集成使用

在项目的.idea文件夹下的misc.xml 文件中加入

<component name="yapi">
  <option name="projectToken">yapi 中项目token</option>
  <option name="projectId">yapi 中项目id</option>
  <option name="yapiUrl">http://127.0.0.1:3000</option>
  <option name="projectType">api</option>
  <option name="returnClass">com.project.Response(1.7.4 及之后才支持,按需配置)</option>
</component>

token 获取方式： 打开yapi ->具体项目->设置->token 配置
项目id 获取方式：点击项目，查看url 中project 后面的数字为项目id http://127.0.0.1:3000/project/72/interface/api
yapiUrl 获取方式：部署的yapi 地址
projectType 填写方式： 根据你要上传的接口类型决定，如果为dubbo 接口就填dubbo ，如果是api 接口就填api
returnClass 填写方式:统一返回对象的全路径
例子：
<component name="yapi">
  <option name="projectToken">b7af366c54358eddece9b31e7ee6a47025fbc0bb58b5c595200a53908051035d</option>
  <option name="projectId">1000</option>
  <option name="yapiUrl">http://127.0.0.1:3000</option>
  <option name="projectType">api</option>
  <option name="returnClass">com.kns.response.ResponseResult</option>
</component>

结合代码使用方法

1.yapi项目创建分组：在controller上加注释

/** 
 * @menu 这里填写类分类名称
 */

/**
 * @menu 任务接口
 */
public class JobController {

2.接口名称 在方法上加注释

/**
*@description: 添加或更新课程数据
*/
或者使用swagger的注解
@ApiOperation("接口名称")

3.请求参数和返回数据为对象，在字段上添加注释

/**
* rule文件名
*/
private String name;

/**
* 是否启用（0禁用，1启用）
*/
private boolean disabled;

4.请求参数为基本类型

/**
*@param ruleName 用户名
*/