Springfox Swagger2(二):常用注解

@ApiIgnore():用于类或者方法上,可以不被swagger显示在页面上 

@Api():用于类表示标识这个类是swagger的资源 

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

@ApiOperation():用于方法;表示一个http请求的操作 

    value用于方法描述 
    notes用于提示内容 
    tags可以重新分组(视情况而用)

@ApiImplicitParams()用于方法,包含多个 @ApiImplicitParam

    name–参数ming 

    value–参数说明 

    required 是否必须 boolean

    dataType–数据类型 

    paramType–参数类型 

        body 使用@RequestBody接收数据 POST有效
        path 在url中配置{}的参数
        query 普通查询参数 例如 ?query=q ,jquery ajax中data设置的值也可以,例如 {query:”q”},springMVC中不需要添加注解接收
        header 使用@RequestHeader接收数据
        form 笔者未使用,请查看官方API文档

    example–举例说明

@ApiImplicitParam() 用于方法 表示单独的请求参数 

    表示单独的请求参数 

@ApiResponses()用于表示一组响应

@ApiResponse():用在@ApiResponses中,一般用于表达一个错误的响应信息

    code:数字,例如400
  message:信息,例如"请求参数没填好"
  response:抛出异常的类

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

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

@ApiModel()用于类 表示对类进行说明,用于参数用实体类接收 

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

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

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











    
    
  • 0
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值