zoukankan      html  css  js  c++  java
  • swagger常用注解

    1.@Api:用在请求的类上,表示对类的说明

    1 tags:说明该类的作用,参数是个数组,可以填多个。
    2 value="该参数没什么意义,在UI界面上不显示,所以不用配置"
    3 description = "用户基本信息操作"

    2.@ApiOperation():用于方法,表示一个http请求访问该方法的操作

    1 value="方法的用途和作用"    
    2 notes="方法的注意事项和备注"    
    3 tags:说明该方法的作用,参数是个数组,可以填多个。
    4 格式:tags={"作用1","作用2"} 
    5 (在这里建议不使用这个参数,会使界面看上去有点乱,前两个常用)

    3.@ApiModel():用于响应实体类上,用于说明实体作用

    1 description="描述实体的作用" 

    4.@ApiModelProperty:用在属性上,描述实体类的属性

    1 value="用户名"  描述参数的意义
    2 name="name"    参数的变量名
    3 required=true     参数是否必选

    5.@ApiImplicitParams:用在请求的方法上,包含多@ApiImplicitParam

    6.@ApiImplicitParam:用于方法,表示单独的请求参数

     1 name="参数ming" 
     2 value="参数说明" 
     3 dataType="数据类型" 
     4 paramType="query" 表示参数放在哪里
     5     · header 请求参数的获取:@RequestHeader
     6     · query   请求参数的获取:@RequestParam
     7     · path(用于restful接口) 请求参数的获取:@PathVariable
     8     · body(不常用)
     9     · form(不常用) 
    10 defaultValue="参数的默认值"
    11 required="true" 表示参数是否必须传

    7.@ApiParam():用于方法,参数,字段说明 表示对参数的要求和说明

    1 name="参数名称"
    2 value="参数的简要说明"
    3 defaultValue="参数默认值"
    4 required="true" 表示属性是否必填,默认为false

    8.@ApiResponses:用于请求的方法上,根据响应码表示不同响应一个@ApiResponses包含多个@ApiResponse

    9.@ApiResponse:用在请求的方法上,表示不同的响应

    1 code="404"    表示响应码(int型),可自定义
    2 message="状态码对应的响应信息"  

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

    11.@Profile({"dev", "test"}):用于配置类上,表示只对开发和测试环境有用

  • 相关阅读:
    MySQL之索引优化
    使用Nginx+Lua(OpenResty)开发高性能Web应用
    Eclipse设置背景色
    删除排序数组中的重复项再练习
    计数排序_数组与集合时间比较
    nodejs+redis应用
    redis的一些优缺点
    Redis的线程模型
    GC仅仅是守护线程,空闲执行
    SpringIOC和AOP的生活案例
  • 原文地址:https://www.cnblogs.com/sunxun001/p/13130318.html
Copyright © 2011-2022 走看看