@Api：放在请求的类上，与 @Controller 并列
说明类的作用，如该类是用于用户模块、商家模块等。
{
  tags="说明该类的作用"
  value="该参数没什么意义，所以不需要配置"
}

@ApiOperation："用在请求的方法上，说明方法的作用"
{
  value="说明方法的作用"
  notes="方法的备注说明"
}

@ApiImplicitParams：用在请求的方法上 包含一组参数说明
  @ApiImplicitParam：对单个参数的说明     
     name：参数名
     value：参数的说明、描述
     required：参数是否必须必填
     paramType：参数放在哪个地方
          · query --> 请求参数的获取：@RequestParam
          · header --> 请求参数的获取：@RequestHeader       
          · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（请求体）-->  @RequestBody User user
          · form（普通表单提交）    
     dataType：参数类型，默认String，其它值dataType="Int" //注意这里不能填integer    
     defaultValue：参数的默认值

@Api(tags="用户模块")
@Controller
public class UserController {
  @ApiOperation(value="用户登录",notes="随边说点啥")
  @ApiImplicitParams({
  @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
  @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
  @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
  })
  @PostMapping("/login")
  public JsonResult login(@RequestParam String mobile, @RequestParam String password,
  @RequestParam Integer age){
  //...
     return JsonResult.ok(map);
  }
}

@ApiResponses：方法返回对象的说明
@ApiResponse：每个参数的说明
   code：数字，例如400
   message：信息，例如"请求参数没填好"
   response：抛出异常的类

@Api(tags="用户模块")
@Controller
public class UserController {
  @ApiOperation("获取用户信息")
  @ApiImplicitParams({
  @ApiImplicitParam(paramType="query", name="userId", dataType="String", required=true, value="用户Id")
  }) 
  @ApiResponses({
  @ApiResponse(code = 200, message = "请求成功"),
  @ApiResponse(code = 400, message = "请求参数没填好"),
  @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")
  }) 
  @ResponseBody
  @RequestMapping("/list")
  public JsonResult list(@RequestParam String userId) {
  ...
  return JsonResult.ok().put("page", pageUtil);
  }
}

@ApiModel(description = "用户登录")
public class UserLoginVO implements Serializable {
  private static final long serialVersionUID = 1L;
  @ApiModelProperty(value = "用户名",required=true)  
  private String username;
  @ApiModelProperty(value = "密码",required=true) 
  private String password;
  // getter/setter省略
}

@Api(tags="用户模块")
@Controller
public class UserController {
  @ApiOperation(value = "用户登录", notes = "") 
  @PostMapping(value = "/login")
  public R login(@RequestBody UserLoginVO userLoginVO) {
  User user=userSerivce.login(userLoginVO);
  return R.okData(user);
  }
}

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{
  @ApiModelProperty(value = "是否成功",required=true)
  private boolean success=true; 
  @ApiModelProperty(value = "错误码")
  private Integer errCode;
  @ApiModelProperty(value = "提示信息")
  private String message;
    @ApiModelProperty(value = "数据")
  private Object data;
  /* getter/setter 略*/
}