首页 > 技术文章 > swagger 注解使用

smplaces 2021-05-12 09:20 原文

@Api()

用于类:表示标识这个类是swagger的资源

image

tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list

@ApiOperation()

用于方法:表示一个http请求的操作

image

value用于方法描述
notes用于提示内容

@ApiParam()

用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等)

image

name–参数名
value–参数说明
required–是否必填

@ApiModel()

用于类 ;表示对类进行说明,用于参数用实体类接收

image

value–表示对象名
description–描述
都可省略

@ApiModelProperty()

用于方法,字段; 表示对model属性的说明或者数据操作更改

image

value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

@ApiIgnore()

用于类或者方法上,可以不被swagger显示在页面上

image

@ApiImplicitParam()

用于方法 :表示单独的请求参数

@ApiImplicitParams()

用于方法,包含多个 @ApiImplicitParam

image

name–参数名
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明

推荐阅读