1 @Api() 用于类;表示标识这个类是swagger的资源 2 tags–表示说明 3 value–也是说明,可以使用tags替代 4 5 @ApiOperation() 用于方法;表示一个http请求的操作 6 value用于方法描述 7 notes用于提示内容 8 9 10 @ApiParam() 用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等) 11 name–参数名 12 value–参数说明 13 required–是否必填 14 15 @ApiModel()用于类 ;表示对类进行说明,用于参数用实体类接收 16 value–表示对象名 17 18 @ApiModelProperty()用于方法,字段; 表示对model属性的说明或者数据操作更改 19 value–字段说明 20 name–重写属性名字 21 dataType–重写属性类型 22 required–是否必填 23 example–举例说明 24 hidden–隐藏 25 26 @ApiImplicitParam() 用于方法 27 表示单独的请求参数 28 29 @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam 30 name–参数ming 31 value–参数说明 32 dataType–数据类型 33 paramType–参数类型 34 example–举例说明 35 36 @ApiIgnore 37 作用于方法上,使用这个注解swagger将忽略这个接口
Swagger 注解说明
最新推荐文章于 2023-06-07 09:49:48 发布