Swagger注解-@ResponseHeader

最新推荐文章于 2021-05-10 17:37:09 发布
最新推荐文章于 2021-05-10 17:37:09 发布
阅读量5.6k 收藏 3
点赞数 1
分类专栏： swagger注解 Swagger 文章标签： Swagger Swagger注解 @ResponseHeader
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dejunyang/article/details/89527310
版权

Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

使用场景

作为 @ApiResponse 的属性，作为返回数据的一部分，指定返回 header 信息

概述

作为返回数据的一部分提供返回数据的 header 信息

属性

属性名称数据类型默认值说明
nameString“”Header’s name.
descriptionString“”response header 详细描述
responseClass<?>Void.classHeader’s data type
responseContainerString“”声明包装响应的容器，有效值为List或Set，任何其他值都将被覆盖

Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

时间会告诉你答案，但不能重来
关注
  • 1
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Response-Headers详解
07-05
Response-Headers详解,WEB开发不可缺少的帮助文档
swagger-ui-react：从swagger-ui生成swagger-ui-react的存储库
02-15
此仓库表示swagger-ui-react的自定义版本，并为基础的swagger-ui构造函数添加了一些传递swagger-ui 。 我们需要使用swagger-ui-react （vs. swagger-ui ），因为它将React列为peerDependency ，这使得它可以很好地与...
HTTP请求头和响应头注释
weixin_33859844的博客
06-08 194
HTTP Request Header 请求头Accept指定客户端能够接收的内容类型。如Accept:text/plain,text/html Accept-Charset浏览器可以接受的字符编码集。如Accept-Charset:iso-8859-5 Accept-Encoding...
Response的Header属性详解
热门推荐
小仙~
11-06 4万+
版权声明：本文为博主原创文章，无需授权即可转载，甚至无需保留以上版权声明，转载时请务必注明作者。 https://blog.csdn.net/weixin_43453386/article/details/83659467 Response的Header属性详解一、Header属性二、Header属性分类1、通用信息头2、请求头3、响应头4、实体头5、扩展头三、Response设置Header属性...
注解：@RequestParam、 @RequestBody、@ResponseBody、@PathVariable @RequestHeader
超人的博客
08-23 498
1. @RequestMapping RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。 RequestMapping注解有六个属性，下面我们把她分成三类进行说明。 1.1、 value， method； value： 指定请求的实际地址，指定的地址可以是URI Template 模式（后面...
【HTTP】Request Header 和 Response Header字段详解
W_jin的博客
05-10 1973
Request Header Header 解释 示例 Accept 指定客户端能够接收的内容类型 Accept: text/plain, text/html Accept-Charset 浏览器可以接受的字符编码集。 Accept-Charset: iso-8859-5 Accept-Encoding 指定浏览器可以支持的web服务器返回内容压缩编码类型。 Accept-Encoding: compress, gzip Accept-Lan
springfox-swagger2-2.9.2-API文档-中文版.zip
07-13
赠送jar包：springfox-swagger2-2.9.2.jar； 赠送原API文档：springfox-swagger2-2.9.2-javadoc.jar； 赠送源代码：springfox-swagger2-2.9.2-sources.jar； 赠送Maven依赖信息文件：springfox-swagger2-2.9.2.pom；...
swagger-bootstrap-ui-1.9.6-API文档-中文版.zip
07-13
赠送jar包：swagger-bootstrap-ui-1.9.6.jar； 赠送原API文档：swagger-bootstrap-ui-1.9.6-javadoc.jar； 赠送源代码：swagger-bootstrap-ui-1.9.6-sources.jar； 赠送Maven依赖信息文件：swagger-bootstrap-ui-...
swagger-annotations-2.1.2-API文档-中文版.zip
05-09
赠送jar包：swagger-annotations-2.1.2.jar； 赠送原API文档：swagger-annotations-2.1.2-javadoc.jar； 赠送源代码：swagger-annotations-2.1.2-sources.jar； 赠送Maven依赖信息文件：swagger-annotations-2.1.2....
HTTP response Header列表
07-19
http请求服务单返回头部可选参数、含义、以及相关示例
Java获取响应头response header
12-22
package com.bighai.forTest; import java.io.IOException; import java.net.URL; import java.net.URLConnection; import java.util.Map; import java.util.Set; public class CheckHttpResposneHeaders { public static void main(String[] args) throws IOException{ URL url = new URL("http://pic.qihoo.com/b
java swagger ui 添加header请求头参数的方法
08-25
今天小编就为大家分享一篇java swagger ui 添加header请求头参数的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
swagger-models-2.1.2-API文档-中文版.zip
05-09
赠送jar包：swagger-models-2.1.2.jar； 赠送原API文档：swagger-models-2.1.2-javadoc.jar； 赠送源代码：swagger-models-2.1.2-sources.jar； 赠送Maven依赖信息文件：swagger-models-2.1.2.pom； 包含翻译后的API...
swagger之接口header控制
H_233的博客
11-18 9761
在大部分项目中，都存在权限控制，基本上大部分的接口都需要用户的登录信息。现在主流的采用如jwt或者其他方式，来通过请求时向header加入token，然后服务端解析token。所以我们需要在swagger生成的接口文档上也要进行header控制，除了接口参数以外，还要输入token header。 这里提供swagger header三种方式： 一、在每个controller接口上，标记swa...
java response header_response.setHeader各种用法详解
weixin_35796591的博客
02-12 1179
一秒刷新页面一次 response.setHeader("refresh","1");二秒跳到其他页面 response.setHeader("refresh","2;URL=otherPagename");没有缓存：response.setHeader("Pragma", "No-cache");response.setHeader("Cache-Control", "no-cache");设置...
Spring的@RequestHeader注释
sinat_36713319的博客
08-14 1万+
SpringMVC提供了可以用于映射控制器参数以请求头值的注释@RequestHeader。以下是spring@RequestHeader注释的简单使用。import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestHeader; import org.s
SpringMVC-RequestHeader注解
weixin_45335305的博客
06-15 454
使用说明 作用： 用于获取请求消息头。 属性： value：提供消息头名称 required：是否必须有此消息头 注：在实际开发中一般不怎么用。 使用示例 jsp <!-- RequestHeader 注解 --> <a href="account/useRequestHeader">获取请求消息头</a> Controller /** * RequestHeader 注解 * @return */ @RequestMa
swagger升级@ApiImplicitParam -> @Parameter详解
最新发布
02-03
Swagger是一种用于描述、构建和生成RESTful风格的Web服务的工具集。它提供了一种简单且易于理解的方式来定义API的结构、参数、返回值等信息，并且可以生成可交互的API文档。 在Swagger中，`@ApiImplicitParam`是一个用于描述API接口参数的注解。它可以用于指定参数的名称、类型、位置、是否必需等信息。然而，从Swagger 3.0版本开始，`@ApiImplicitParam`已经被废弃，取而代之的是`@Parameter`注解。 `@Parameter`注解与`@ApiImplicitParam`类似，用于描述API接口参数。它可以指定参数的名称、类型、位置、是否必需等信息。与`@ApiImplicitParam`不同的是，`@Parameter`注解提供了更加灵活和可扩展的功能，可以支持更多的参数类型和配置选项。 使用`@Parameter`注解时，你可以通过设置`in`属性来指定参数的位置，例如`in = ParameterIn.PATH`表示参数位于URL路径中，`in = ParameterIn.QUERY`表示参数位于URL查询参数中，`in = ParameterIn.HEADER`表示参数位于请求头中，等等。 此外，你还可以使用`@Parameter`注解的其他属性来指定参数的名称、类型、是否必需等信息。例如，你可以使用`name`属性指定参数的名称，使用`schema`属性指定参数的数据类型，使用`required`属性指定参数是否必需等。 总结一下，`@Parameter`注解是Swagger 3.0版本中用于描述API接口参数的注解，它提供了更加灵活和可扩展的功能，可以替代`@ApiImplicitParam`注解。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值