安装和使用 EasyApi 插件

EasyApi

EasyApi 是什么

EasyApi 是一款 IDEA 插件，他的功能是使后端开发者能更好地对接 YApi。

为什么需要对接

EasyApi 插件是用来对接 YApi 的，那为啥要对接呢？或者说为啥要有接口文档呢？

我们回想一下以前的开发模式：

后端写好接口，告知前端
前端看完开始写前端接口代码
后端改了接口，又要重新告知前端
前端根据接口修改，又要修改前端对应的代码

这样沟通成本很高~

那如果有一个东西可以实时记录后端接口的话，那就减少很多沟通成本了~

使用 EasyApi插件

下载、安装 EasyApi 插件

配置 server、token

在 IDEA 设置中配置好 YApi server 和个人的 tokens

token获取

代码

 /**
* 这部分会变成分组名
* 这部分是分组的说明信息
*
* @Description 活动
* @Author ZhouLiangCheng
* @Date 2022/10/20
* @Version 1.0
*/
@RestController
@RequestMapping("/export/yapi")
public class ExportYapiController {

    /**
* 这部分会作为api的名称
* 这部分会变成api的说明信息
*
* @param param1 参数1的描述
* @param param2 {@link DescEnum#bb}
* @param param3 {@link DescEnum#aa}
* @return desc of response
*/
    @GetMapping("/get1")
    public Result<String> get1(Long param1, @RequestParam String param2,
                               @RequestParam(required = false, defaultValue = "aa") DescEnum param3) {
        return Result.success("123");
    }

    /**
* 废弃请求
* 默认请求类型为 content-type:`application/x-www-form-urlencoded`，
* 但是标记有 @RequestBody 的参数会设置为 'application/json'
*
* @param map 任意
* @return version
* @deprecated use {@link #post2(Map)} )} instead of
*/
    @Deprecated
    @PostMapping("/post1")
    public Result<Integer> post1(@RequestBody Map<String, String> map) {
        return Result.success(1);
    }

    /**
* 船新版本
*
* @param map 任意
* @return version
*/
    @PostMapping("/post2")
    public Result<Integer> post2(@RequestBody Map<String, String> map) {
        return Result.success(2);
    }

    @Getter
    @AllArgsConstructor
    public static enum DescEnum {
        // desc
        aa("this a"),
        bb("from b"),
        ;

        final String desc;
    }
}