swagger注解

1 controller注解

1. @api注解放在controller类上，value中填写此类名，description里放描述

@Api(value = "WxController", description = "微信相关，包括获取微信用户信息")
public class WxController {
    ....
}

1. 参数注解 @ApiImplicitParam 单个参数使用，是输入参数的消息描述和限制
   注意paramType的使用，如果是使用restful风格传参，paramType一定要写成：paramType = “path”

@ApiOperation(value = "向邮箱发送验证码,status=200可用",notes = "向邮箱发送验证码")
@ApiImplicitParam(name = "email",value = "邮箱",required = true,dataType = "String",paramType = "path")
@GetMapping("sendCodeToEmail/{email:.+}")
public HealthResult sendCodeToEmail(@PathVariable(value = "email") String email){
    HealthResult result = userService.sendCodeToEmail(email);
    return result;
}