程序员经验分享-hwhale

Swagger注解详解

2023-11-13

目录

1. @Api

2. @APiOperation

3. @ApiImplicitParams

4. @ApiResponses

5. @ApiModel

6. @ApiModelProperty

这里是说明常用注解的含义和基本用法（也就是说已经对swagger进行集成完成） 
没有集成的请参见 
SpringBoot集成springfox-swagger2构建restful API 
SpringMVC集成springfox-swagger2构建restful API 

1. @Api

协议集描述，用在Controller类上

  • value - 字段说明
  • tags- 注释说明这个类

2. @APiOperation

协议描述，用在Controller方法上，一般有value和notes

  • value - 字段说明
  • notes - 注释说明
  • httpMethod - 说明这个方法被请求的方式
  • response - 方法的返回值的类型

3. @ApiImplicitParams

非对象描述参数集，用在Controller方法上，里面可以加多个@ApiImplicitParam

一般在GET请求上面加

name：参数名

value：参数的汉字说明、解释

required：参数是否必须传

dataType：参数类型，默认String，其它值dataType="Integer"

defaultValue：参数的默认值

paramType：参数放在哪个地方

  • header --> 请求参数的获取：@RequestHeader
  • query --> 请求参数的获取：@RequestParam
  • path（用于restful接口）--> 请求参数的获取：@PathVariable
  • body（不常用）
  • form（不常用）

4. @ApiResponses

表示一组响应，用在Controller方法上，@ApiResponse一般用于表达一个错误的响应信息。

  • code：数字，例如400

  • message：信息，例如"请求参数没填好"

  • response：抛出异常的类

5. @ApiModel

表示一个返回响应数据的信息，用于响应类上

  • （这种一般用在post创建的时候，使用@RequestBody这样的场景，

  • 请求参数无法使用@ApiImplicitParam注解进行描述的时候）

  • @ApiModel("类的描述")

6. @ApiModelProperty

描述响应类的属性，用在属性上。

  • @ApiModelProperty("属性描述")

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

知识点小计

spring boot

Java

Spring

Swagger注解详解 的相关文章

随机推荐

  • bp神经网络预测未来数据,bp神经网络如何预测

    bp神经网络算法后的结果看不懂 都是英文 预测值怎么弄出来 高手指导一下 p test out sim net p test 训练结束后用验证样本检验网络的预测效果 是验证数据的输入 模型会自动给出预测输出值 将预测值与真实值对比看看模型是

  • ZooKeeper（一）：基础介绍

    文章目录 什么是 ZooKeeper ZooKeeper 发展历史 ZooKeeper 应用场景 ZooKeeper 服务的使用 ZooKeeper 数据模型 data tree 接口 znode 分类 总结 什么是 ZooKeeper Z

  • 机器学习-Sklearn-11（支持向量机SVM-SVC真实数据案例：预测明天是否会下雨）

    机器学习 Sklearn 11 支持向量机SVM SVC真实数据案例 预测明天是否会下雨 11 SVC真实数据案例 预测明天是否会下雨 这个案例的核心目的 是通过巧妙的预处理和特征工程来向大家展示 在现实数据集上我们往往如何做数据预处理 或

  • Java中ASCII码与字符之间的相互转换

    ASCII码转字符 char word char 97 强制转换 字符转ASCII码 int value a 加

  • STM32 进阶教程 17 - ADC注入通道

    前言 STM32 的ADC的一个强大功能是支持触发注入功能 在103中每个ADC模块支持4个注入通道 每个注入通道具有独立的结果突存器 注入通道具有较规划通道更高的优先级 在实际工程应用中 注入通道更多地会使用外部触发方式进行触发转换 关于

  • 时序预测相关技术分享

    时序预测相关技术分享 时序预测是指对时间序列数据进行预测 以预测未来的趋势或行为 在实际生产和应用中 时序预测广泛应用于金融 电力 交通等领域 时序预测可以帮助人们更好地理解和掌握未来的趋势和规律 从而做出更明智的决策 时序预测技术的方法和

  • 两个虚拟机互相拷贝文件或者文件夹

    互相拷贝文件 scp root k8s images tar bz2 root 192 168 33 16 root 将mysql配置文件上传到16服务器相应文件夹内 scp root 192 168 33 16 etc mysql my

  • React + Ts 实现三子棋小游戏

    在这里阅读效果更佳 还记得当年和同桌在草稿纸上下三子棋的时光吗 今天我们就用代码来重温一下年少 假设你有react基础 没有也行 只要你会三大框架的任意一种 上手react不难 游戏规则 双方各执一子 在九宫格内一方三子连成线则游戏结束 九

  • 为什么程序员都想进互联网大公司，看看福利就知道了

    每年年的最后一个月 一年的辛苦不易除了放假就盼着年终奖了 一直以来被外行人称为 钱多话少 的程序员 到了年底也都能拿到不少的年终奖 毕竟都是996拼出来的 那么国内的互联网年终奖能拿到多少呢 年终奖只是一个平均的 因为每个人的入职时间不同

  • linux离线安装glibc.i686

    一 下载相关rpm包 链接 https pan baidu com s 1Of1myRZa2ClrlSYw43OR3Q 提取码 hlsq 二 将相关rpm包复制到服务器上 三 执行sh install sh即可

  • 如果当前node.js版本和项目需要版本不一样，卸载重装其他版本node.js的方法

    其实这种node js版本不一样的问题 可以选择用nvm来管理node js的不同版本 此处仅总结卸载当前版本node js 重新安装所需版本node js的方法 另 现在 用Vite官网里面的 yarn npm等 的方法 创建Vue3项目

  • DOPI EV200轻松跑debain+jupyter

    硬件 DOPI EV200开发板 一张16G的TF卡 一条usb线 安装好RNIDS驱动 并分配IP地址 详细参考玩转rtsp一文章 上电启动后 程序从Nand Flash启动后 文件系统制作在TF卡中 debain jupyter在1 3

  • ST-Link/v2驱动安装

    链接 https pan baidu com s 1ZXAxwZa46z6K8 U3HW0qvg 提取码 ofmu 从连接里拿到一个名为en stsw link009 v2 0 2 zip的压缩包 如上图所示 新建一个文件夹 ST Link

  • 【微信小程序】文章设置

    设置基本字体样式 行高 首行缩进 font size 32rpx line height 1 6em text indent 2em padding 20rpx 0 border bottom 1px dashed var themColo

  • rabbitmq基础7——队列和消息过期时间设置、死信队列、延迟队列、优先级队列、回调队列、惰性队列

    文章目录 一 过期时间 1 1 针对队列设置 1 2 针对消息设置 二 死信队列 2 1 死信交换器 2 2 死信队列原理 2 3 延迟队列 特殊用法 三 优先级队列 3 1 监控页面创建优先级队列 3 2 监控页面创建优先级消息 四 回调

  • 【有限元分析】网格形状和网格尺寸对结果的影响——以矩形杆的静力分析为例

    本文研究了网格形状和网格尺寸对计算结果的影响 现研究一个矩形截面的杆件 如图1 1 对其末端施加两种等效的载荷 在末端面施加remote force 100N的力 如图1 2所示 对杆件进行2种网格形状划分 分别是六面体网格和四面体网格 如

  • 金融术语总结

    洗钱 将犯罪或其他非法违法行为所获得的违法收入 通过各种手段掩饰 隐瞒 转化 使其在形式上合法化的行为 存量客户 某个时间段里原先已有的客户 与新增客户相对应 月活跃用户数量 MAU Monthly Active User MAU 是当月登

  • 网页常用小技巧(JavaScript)

    1 nc ntextmenu window event returnValue false 将彻底屏蔽鼠标右键 table border border td no td table 可用于Table 2 取消选取 防止复制 3 npaste

  • java日志框架详解

    一 日志的概念 日志文件是用于记录系统操作事件的文件集合 可分为事件日志和消息日志 具有处理历史数据 诊断 问题的追踪以及理解系统的活动等重要作用 二 现有的日志框架 JUL java util logging logback log4j

  • Swagger注解详解

    目录 1 Api 2 APiOperation 3 ApiImplicitParams 4 ApiResponses 5 ApiModel 6 ApiModelProperty 这里是说明常用注解的含义和基本用法 也就是说已经对swagge

热门标签