专栏首页专注于主流技术和业务swagger注解API详细说明

swagger注解API详细说明

注解说明

作用范围

API

使用位置

对象属性

@ApiModelProperty

用在出入参数对象的字段上

协议集描述

@Api

用于controller类上

协议描述

@ApiOperation

用在controller的方法上

Response集

@ApiResponses

用在controller的方法上

Response

@ApiResponse

用在 @ApiResponses里边

非对象参数集

@ApiImplicitParams

用在controller的方法上

非对象参数描述

@ApiImplicitParam

用在@ApiImplicitParams的方法里边

描述返回对象的意义

@ApiModel

用在返回对象类上

注解@ApiImplicitParam的paramType参数使用说明

paramType:表示参数的类型使用场景说明

类型

使用说明

举例

header

请求参数的获取:@RequestHeader(代码中接收注解)

query

请求参数的获取:@RequestParam(代码中接收注解),

getUser?user =admin

path(用于restful接口)

请求参数的获取:@PathVariable(代码中接收注解)

getUser/user/admin

body

请求参数的获取:@RequestBody(代码中接收注解)

form

(不常用)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • CopyOnWrite 思想及其应用场景

    CopyOnWrite(简称COW,中文意思是:写入时复制)就是在进行写操作时,先复制要改变的对象,对副本进行写操作,完成对副本的操作后,把原有对象的引用指向副...

    飞狗
  • Scrypt算法

    Scrypt是内存依赖型的POW算法,莱特币采用此算法。第一个使用Scrypt算法的数字货币是Tenebrix,而后该算法被莱特币使用。莱特币创始人在莱特币创世...

    飞狗
  • SpringBoot实践-BeanPostProcessor的作用和妙用

    BeanPostProcessor也称为Bean后置处理器,它是Spring中定义的接口,在Spring容器的创建过程中(具体为Bean初始化前后)会回调Bea...

    飞狗
  • Qt Quick编程(1)——QML的核心部分ECMAScript

    说道QML,不得不先说一下ECMAScript: ECMAScript语言的标准是由Netscape、Sun、微软、Borland等公司基于JavaScript...

    CN_Simo
  • Serverless+SCF=打倒服务器,解放程序员 | 技术沙龙

    在很多外行人的眼里,程序员就是神一样的存在。他们全年 996,节假日无休,不仅 Java、PHP、C++ 要样样精通,还要会修电脑修音响修手机,做前端要懂运维,...

    用户1516716
  • iView-----日历组件

    用户4344670
  • Python+numpy实现矩阵的行列扩展

    Python小屋屋主
  • 基础知识 | 每日一练(133)

    士人有百折不回之真心,才有万变不穷之妙用。立业建功,事事要从实地着脚,若少慕声闻,便成伪果;讲道修德,念念要从虚处立基,若稍计功效,便落尘情。 ...

    闫小林
  • 第八节、Python中raw字符串与多行字符串《Python学习》

    如果一个字符串包含很多需要转义的字符,对每一个字符都进行转义会很麻烦。为了避免这种情况,我们可以在字符串前面加个前缀r ,表示这是一个 raw 字符串,里面的字...

    申霖
  • 开发你不能忽略的问题?JavaScript(JS)

    一、JavaScript基础加强 ? JavaScript是在浏览器内容运行,无需编译、解释执行动态脚本语言,是一种弱类型语言,所有变量使用var定义。 Ja...

    奋斗蒙

扫码关注云+社区

领取腾讯云代金券