@ApiOperation是一个描述接口信息的注解
注解内的常用属性有
value:接口说明
notes:接口发布说明
httpMethod:接口请求方式(例如:GET、POST)
response:接口返回参数类型(例如:String.class)
@ApiOperation(value="用户登录",notes="用户登录",httpMethod="GET",response=String.class) @RequestMapping("/login",method = {RequestMethod.GET})
public String login(){ return "success"; }
@ApiParam是一个描述方法参数的注解
注解内的常用属性有
name:参数名(与请求参数参数名一致)
value:参数说明
required:是否必须
@RequestMapping("/login") public String login(@ApiParam(name="userId",value="登录userId",required=true) String userId){ return "success"; }
@ApiParam和@ApiImplicitParam类似,都是对方法参数进行标注,但是注解添加的位置不同,@ApiParam添加在方法参数前,@ApiImplicitParam添加在方法前,@ApiImplicitParam拥有dataType和paramType