swagger常用注解[通俗易懂]

一、swagger常用注解1、与模型相关的注解两个注解:@ApiModel:用在模型类上,对模型类做注释;@ApiModelProperty:用在属性上,对属性做注释2、与接口相关的注解六个注解:@Api:用在controller上,对controller进行注释;@ApiOperation:用在API方法上,对该API做注释,说明API的作用;

大家好,又见面了,我是你们的朋友全栈君。

一、swagger常用注解
1、与模型相关的注解
两个注解:
  • @ApiModel:用在模型类上,对模型类做注释;
  • @ApiModelProperty:用在属性上,对属性做注释
2、与接口相关的注解
六个注解:
  • @Api:用在controller上,对controller进行注释;
  • @ApiOperation:用在API方法上,对该API做注释,说明API的作用;
  • @ApiImplicitParams:用来包含API的一组参数注解,可以简单的理解为参数注解的集合声明;
  • @ApiImplicitParam:用在@ApiImplicitParams注解中,也可以单独使用,说明一个请求参数的各个方面,该注解包含的常用选项有:
  • paramType:参数所放置的地方,包含query、header、path、body以及form,最常用的是前四个。
  • name:参数名;
  • dataType:参数类型,可以是基础数据类型,也可以是一个class;
  • required:参数是否必须传;
  • value:参数的注释,说明参数的意义;
  • defaultValue:参数的默认值;
  • @ApiResponses:通常用来包含接口的一组响应注解,可以简单的理解为响应注解的集合声明;
  • @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
  • code:即httpCode,例如400 
  • message:信息,例如”请求参数没填好”
二、几个注意点:
  1. 为了在swagger-ui上看到输出,至少需要两个注解:@Api和@ApiOperation
  2. 即使只有一个@ApiResponse,也需要使用@ApiResponses包住
  3. 对于@ApiImplicitParam的paramType:query、form域中的值需要使用@RequestParam获取, header域中的值需要使用@RequestHeader来获取,path域中的值需要使用@PathVariable来获取,body域中的值使用@RequestBody来获取,否则可能出错;而且如果paramType是body,name就不能是body,否则有问题,与官方文档中的“If paramType is “body”, the name should be “body”不符。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/129676.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • 集合框架二:List

    集合框架二:List

  • macOS升级node

    macOS升级nodemacOS升级node1、安装node管理模块nnpminstall-gn2、安装需要升级的node版本sudon16.14.03、关闭终端重新打开,查看node版本验证升级完成node-v

  • 前后端报文传输加密方案

    前后端报文传输加密方案开发人员联系方式:251746034@qq.com代码库:https://github.com/chenjia/vue-desktop代码库:https://github.com/chenjia/vue-app代码库:https://github.com/chenjia/lxt示例:http://47.100.119.102/vue-desktop示例:http://47.100.119…

  • jboss 配置文件_黑果小兵安装教程

    jboss 配置文件_黑果小兵安装教程一、Jboss下载:  1、点击 http://jbossas.jboss.org/downloads/找到合适的版本下载;  我这里是用的Jboss-as-7.1.1.Final版本,算是比较新的一个版本。    二、Jboss安装:  1、首先将下好的Jboss解压到自己想要存放的位置;  2、配置环境变量(非必要步骤),建议还是将环境变量配好,便于dos中命令操作;   …

  • 【OpenCV】SIFT原理与源码分析

    【OpenCV】SIFT原理与源码分析SIFT简介ScaleInvariantFeatureTransform,尺度不变特征变换匹配算法,是由DavidG.Lowe在1999年(《ObjectRecognitionfromLocalScale-InvariantFeatures》)提出的高效区域检测算法,在2004年(《DistinctiveImageFeaturesfromScale-Inva

  • Json的常用方法[通俗易懂]

    Json的常用方法[通俗易懂]Json的常用方法

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号