注解@Api,@ApiOperation,@ApiParam说明
swagger的一些注释:
1.@API 是用在类上,表明是swagger资源, 拥有两个属性:value、tags
注:生成的api文档会根据tags分类,即这个controller中的所有接口生成的接口文档都会在tags这个list下;tags如果有多个值,会生成多个list,每个list都显示所有接口 value的作用类似tags,但不能有多个值
2.@ApiOperation 是用在方法上,表示一个http请求的操作 value用于方法描述 notes用于提示内容 tags可以重新分组
3.@ApiParam 是用在方法或参数上字段说明;表示对参数的添加元数据(说明或是否必填等) name 参数名 value参数说明 required 是否必填
参考: @ApiModel:用对象来接收参数 @ApiProperty:用对象接收参数时,描述对象的一个字段 @ApiResponse:HTTP响应其中1个描述 @ApiResponses:HTTP响应整体描述 @ApiIgnore:使用该注解忽略这个API @ApiError :发生错误返回的信息 @ApiImplicitParam:一个请求参数 @ApiImplicitParams:多个请求参数
