（傲娇的白狐）Swagger给实体类 接口加注释

Posted 2020-12-18 aojiaodebaihublog

 

----- swagger 给一些比较难以理解的属性或者接口 加上注释

---- 接口文档实时更新

-===============接口============== 加注释

/ 只要扫描的接口中存在实体类，它就会被扫描到swagger中。
@ApiOperation("postuserinfo方法")
@PostMapping("/userinfo")
public Userinfo get(){

return new Userinfo();
}

@ApiOperation("post 方法")
@PostMapping("/postuset")
public String postud(@ApiParam("userinfo") String userinfo){

return "欢迎post "+userinfo;
}

@ApiOperation("get 方法")
@GetMapping("/getuset")
public String getud(@ApiParam("userinfo") String userinfo){

return "欢迎get "+userinfo;
}

================ 实体类

@ApiModel("用户实体类")
public class Userinfo {
@ApiModelProperty("用户ID")
private int id;

@ApiModelProperty("用户名")
private String name;

@ApiModelProperty("用户密码")
private String password;