Swagger常用注解表格汇总

常用的注解及其使用位置如下：

@Api：用在请求的类上，表示对类的说明常用参数

代码示例：

@Api(tags="登录")
@Controller
@RequestMapping(value="/sign")
public class LoginController {}

@ApiOperation：用在请求的方法上，说明方法的用途、作用

代码示例：

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名判断用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){}

 @ApiModel：用于响应类上，表示一个返回响应数据的信息

 @ApiModelProperty:用在属性上，描述响应类的属性

 示例代码：

@ApiModel(value="用户登录信息", description="判断用户是否存在")
public class UserModel implements Serializable{
    
private static final long serialVersionUID = 30;

@ApiModelProperty(value="用户名")

private String account;

@ApiModelProperty(value="密码")

private String password;

}