SpringBoot 向 YApi 导入接口文档
官方网址：easyyapi
Idea 安装插件 Easy-Yapi
略
编写对应注释
@NotNull 将字段表示为“必须”
@see some.enum.or.constant.class 将字段指向某个枚举类
1
2
3
4
5
6
7
8
9
10
11
12
|
@Data
public class UserInfo {
/**
* guid
*/
@NotNull
private String guid;
/**
* 用户名
*/
private String username;
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
/**
* 用户 Controller
*
* @author GuoYingdong
* @date 2022/11/22
*/
@RestController
@RequestMapping("/user")
public class UserController {
/**
* 获取用户信息
* 备注内容
*
* @return {@link ResponseBean}<{@link XaUserInfo}>
*/
@GetMapping("/getUserInfo")
public ResponseBean<XaUserInfo> getUserInfo() {
XaUserInfo xaUserInfo = RequestContextUtil.getCurrentUser();
return ResponseBean.success(xaUserInfo);
}
}
|
导入 YApi
右键 Controller 类名，选择 Export YApi，即可导入类中所有接口的信息；
右键 Controller 中单个方法名，选择 Export YApi，即可导入单个接口的信息；
第一次点击会弹出 YApi 的配置框，根据提示填写即可。（YApi 的部署 ip 地址；项目 token）
结果示例
