swagger常用注解汇总

swagger中常用的注解及其使用位置如下&＃xff1a;

&＃64;Api&＃xff1a;用在请求的类上&＃xff0c;表示对类的说明常用参数

代码示例&＃xff1a;

&＃64;Api(tags&＃61;"登录请求")
&＃64;Controller
&＃64;RequestMapping(value&＃61;"/highPregnant")
public class LoginController {}

&＃64;ApiOperation&＃xff1a;用在请求的方法上&＃xff0c;说明方法的用途、作用

代码示例&＃xff1a;

&＃64;ResponseBody
&＃64;PostMapping(value&＃61;"/login")
&＃64;ApiOperation(value &＃61; "登录检测", notes&＃61;"根据用户名、密码判断该用户是否存在")
public UserModel login(&＃64;RequestParam(value &＃61; "name", required &＃61; false) String account,
&＃64;RequestParam(value &＃61; "pass", required &＃61; false) String password){}

&＃64;ApiModel&＃xff1a;用于响应类上&＃xff0c;表示一个返回响应数据的信息
示例代码&＃xff1a;

&＃64;ApiModel(value&＃61;"用户登录信息", description&＃61;"用于判断用户是否存在")
public class UserModel implements Serializable{private static final long serialVersionUID &＃61; 1L;
/*** 用户名*/&＃64;ApiModelProperty(value&＃61;"用户名")private String account;/*** 密码*/&＃64;ApiModelProperty(value&＃61;"密码")private String password;}

&＃64;ApiModelProperty:用在属性上&＃xff0c;描述响应类的属性

代码示例&＃xff1a;

&＃64;ApiModel(value&＃61;"用户登录信息", description&＃61;"用于判断用户是否存在")
public class UserModel implements Serializable{private static final long serialVersionUID &＃61; 1L;/*** 用户名*/&＃64;ApiModelProperty(value&＃61;"用户名")private String account;/*** 密码*/&＃64;ApiModelProperty(value&＃61;"密码")private String password;}

&＃64;ApiIgnore 忽略某个属性&＃xff0c;使之不显示在swagger文档中显示

&＃64;GetMapping(value &＃61;"page")
&＃64;ApiOperation(value &＃61;"分页查询登录⽇志")
public Result page(&＃64;ApiIgnore LogVo vo){return null;
}