swagger注解及使用说明

用在类上:

@Api()    用在类上,说明类得作用(标识这个类是swagger得资源)

    tags:表说明

    value:表说明可使用tags代替

@ApiIgnore()    用于类、方法、方法参数(表示这个方法或类被忽略)      


用在方法上:

@ApiOperation()    用在方法上,说明方法得作用(表示一个http请求得操作)

    value    用于方法描述

    notes    用于提示内容

    tags    可以重新分组

@ApiImplicitParams    用在方法上,包含一组参数说明,A皮Implicit Param[] value() 包含多个@ApoIimplicitParam

@ApiImplicitParam()    用在@ApiImplicitParams注解中,指定一个请求参数得各个方面

    paramType    参数放在那个地方

        header:请求参数得获取@RequestHeader

        query:请求参数得获取@RequestParam

        path(用于restful接口):请求参数得获取@PathVariable

        body:(不常用)

        form:(不常用)

    name    参数名

    dataType    参数类型

    required    参数是否必填

    value    参数说明

    defaultValue    参数得默认值

@ApiResponses    表示一组响应

@ApiResponse    用在@ApiResponses中用于表达一个错误得响应信息

    code    数字

    message    信息

    response    抛出异常得类

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

    name    参数名

    value    参数说明

    required    是否必填


实体类:

@ApiModel()    描述一个model得信息,一般用在post创建得时候,使用@RequestBody得场景,请求西安舒无法使用@ApiImplicitParam注解进行描述时(表示对类进行说明,参数用实体类接收)

    value    表示对象名

    description    描述

@ApiModelProperty()    描述对model属性得说明或数据操作的更改

    value    字段说明

    name    重写属性名字

    dataType    重写属性类型

    required    是否必填

    example    举例说明

    hidden    隐藏

  @Authorization    声明要在资源上操作使用的授权方案

  @AuthorizationScope    介绍一个OAuth2授权范围

  @ResponseHeader    响应头设置,使用方法

  @ApiSort    排序

      value    int值

  

  

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339