Yapi是一个接口管理平台,而easyYapi是方便接口生成和管理的一个idea插件。
1 打开插件安装页面 idea>file>setting>plugins 搜索easyYapi 安装后重启
插件中心下载失败的话,可以通过压缩包的形式导入:
2 配置server和token
server 就是yapi管理平台服务器地址
token 是识别项目的唯一信息 图中就是项目token,不同的项目token 不一样
idea中配置server和token
idea>file>setting>EasyYapi 如下图
将server和token 填写完成 点击ok
3 将接口推送至yapi管理平台
方式一 选中controller文件可以选多个(鼠标在文件目录上) ,或者选择整个文件夹 alt+shift+e 就可以了
方式二 选中单个controller文件 (鼠标在文件内部) 右键generate ->export yapi
注意:controller.java文件必须要有文件注释,文件中的方法需要添加注解@RequestMapping/@PostMapping等任意一个 不添加无法识别方法为接口方法 。就算父类方法添加了注解@RequestMapping/@PostMapping也无法识别, 方法必须添加方法注释(接口名称就是根据方法注释生成)
入参对象属性加上注解@NotNull 就变成必输了。