@Api
用在Controller层上的,表示对类的说明,tags="说明该类的作用,可以在UI界面上看到的注解"
@ApiOperation
用在请求的方法上,说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明"
@ApiImplicitParams
@ApiImplicitParams:用在请求的方法上,表示一组参数说明 @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 name:参数名,不能为null value:参数的汉字说明、解释 required:参数是否必须传 defaultValue:参数的默认值
@ApiModel
用于响应类上(接收参数是个对象),表示一个返回响应数据的信息 这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候
value:标注实体是做什么的
description:描述信息,内容可以在UI界面显示出来
@ApiModelProperty
用在属性上,描述响应类的属性
value:信息描述,内容可以在UI界面显示出来
required:必填值
hidden:可以在UI界面上隐藏不显示,比如一些is_deleted这些前端是不需要传递的
@ApiIgnore
用于隐藏接口方法中的参数,只读该类的对象无法进行修改,比如HttpSession session