idea中使用yapi插件自动生成yapi接口文档

1、在idea的plugin中搜索easy-yapi插件

2、安装后重启idea

3、打开setting，在Other Settings下出现EasyApi菜单项，点开出现如下界面

4、填充Yapi地址

5、打开我们想要生成Yapi文档的Controller中

6、同时按住 Shift + Alt + E 即会出现如下弹窗

7、点击绿色钩子后，会弹出一个输入框，让你输入Yapi对应项目下的Token

8、打开Yapi中对应的项目，在设置下的token配置中，找到对应的token，点击右边的复制

9、将复制的token贴入idea中的弹框中

10、点击OK，后即可在Yapi的接口列表中出现对应的接口文档

11、如果代码请求体或返回体发生了变更，这里测试新增一个userName的入参

12、再次上传到Yapi，Yapi该接口的文档会被更新

---

补充一下图中的返回体结构

ResBean.class

package com.lbb.model.dto;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.lbb.model.enums.BizErrorEnum;
import lombok.Data;

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResBean<T> {
     

    private static final String SUCCESS_CODE = "200";

    /**
     * 返回code码，200成功，其他失败
     */
    private String code;

    /**
     * 错误信息
     */
    private String errorMsg;

    /**
     * 返回体
     */
    private T data;

    /**
     * 成功返回
     *
     * @return
     */
    public static <T> ResBean<T> success() {
     
        return new ResBean<>();
    }

    /**
     * 成功返回携带数据体
     *
     * @param data
     * @return
     */
    public static <T> ResBean<T> successWithObj(T data) {
     
        ResBean<T> resBean = new ResBean<>();
        resBean.setCode(SUCCESS_CODE);
        resBean.setData(data);
        return resBean;
    }

    /**
     * 错误返回携带信息
     *
     * @param errorCode
     * @param errorMsg
     * @return
     */
    public static <T> ResBean<T> failWithMsg(String errorCode, String errorMsg) {
     
        ResBean<T> resBean = new ResBean<>();
        resBean.setCode(errorCode);
        resBean.setErrorMsg(errorMsg);
        return resBean;
    }

    /**
     * 错误返回携带数据体
     *
     * @param errorCode
     * @param data
     * @return
     */
    public static <T> ResBean<T> failWithObj(String errorCode, T data) {
     
        ResBean<T> resBean = new ResBean<>();
        resBean.setCode(errorCode);
        resBean.setData(data);
        return resBean;
    }

    public static <T> ResBean<T> failWithErrorEnum(BizErrorEnum errorEnum) {
     
        return failWithMsg(errorEnum.getCode(), errorEnum.getMsg());
    }
}

UserVO.class

package com.lbb.model.vo;

import lombok.Data;

import java.util.List;

/**
 * 用户对象
 */
@Data
public class UserVO {
     

    /**
     * 用户id
     */
    private Integer userId;

    /**
     * 用户名
     */
    private String userName;

    /**
     * 年龄
     */
    private Integer age;

    /**
     * 兴趣爱好
     */
    private List<String> habbits;

}