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)


相关推荐

  • 数据挖掘十大经典算法(包括各自优缺点 / 适用数据场景)

    数据挖掘十大经典算法(包括各自优缺点 / 适用数据场景)本文主要分析皆来自其他资料,借用较为权威的总结来对我已经学习的这些经典算法做一个极为精简的概述(根据自身经验有一定修改),另外同时附上机器学习实战中作者对各种算法的评价。另外机器学习实战这本书是本人看了这么多书籍或者资料中唯一一本坚持从头看到尾,看完了的书籍,包括其中的代码皆实践运行过,收获颇多,个人认为虽然这本书时间上已经算是老资料了,但其中作者的各种总结和代码的演练都由浅入深(前提还是要有一点…

  • pycharm环境变量配置失败_pycharm配置anaconda虚拟环境

    pycharm环境变量配置失败_pycharm配置anaconda虚拟环境去年编程的时候其实就看到有一些提示信息说,2021年元旦之后,python3.5就不再支持了。没想到今天配置新电脑,下载了新的pycharm版本的时候,就遇到这个问题如果一个环境前面显示了unsupported那表明,这个版本太老了,不再被支持。参考Pycharm社区文档:ConfigureaPythoninterpreter当pycharm不再支持一个过期的python版本时,对应的python编译器会被标记为unsupported…

  • python各种库的安装_ad常用软件库

    python各种库的安装_ad常用软件库方法一:需要在网络条件下安装win+R进入运行框输入命令cmd点击确定进入普通下载:pipinstall模块名字例如:输入pipinstallpygamepipinstallnumpypipinstallxlwt—–xlwt代表需要安装所需包和库等列出安装版本:piplist和pipfreeze卸载模块:pipuninstallxlwtY–确定卸载,n–否指定版本下载:pipinstall…

  • 分享pycharm如何安装插件(Plugins)

    分享pycharm如何安装插件(Plugins)链接:https://plugins.jetbrains.com/pycharm一、把插件的zip文件下载到本地二、File=>settings=>plugins本来可以像vscode一样直接搜直接安装,但是它一直转不出来,所以我先去上面的官网下载插件到本地再安装三、点开updates后面的小齿轮,选择installpluginfromdisk(从硬盘下载),选择刚刚下…

  • JDK11安装包(win版)「建议收藏」

    链接:https://pan.baidu.com/s/1S10D5sA8WkYcyOjnE1M5IA提取码:pl26

  • hihoCoder – 1082 – 然而沼跃鱼早就看穿了一切 (字符串处理!!)

    hihoCoder – 1082 – 然而沼跃鱼早就看穿了一切 (字符串处理!!)

发表回复

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

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