swagger中如何给请求添加header

目录
  • 如何给请求添加header
    • 1.后台代码如下
    • 2.添加后的swagger中接口样式如下
  • swagger添加头部参数
    • 1.代码截图
    • 2.使用代码
    • 3.swagger文档说明截图显示
    • 4.swagger文档调试显示框

如何给请求添加header

背景：在集成了swagger的项目中，调用后台接口往往会经过一些自定义的拦截器，而拦截器加了token限制的话，直接在swagger页面中请求后台接口会调不通，那么就需要在swagger中也设置请求token

1.后台代码如下

required(false) 表示userToken非必填，因为有的请求无需token验证。

2.添加后的swagger中接口样式如下

其中，userToken对应步骤一中定义的userToken

swagger添加头部参数

本例头部信息为token权限，当然使用其他的参数原理相同

1.代码截图

2.使用代码

@ApiImplicitParam(value = "鉴权token",name = "token",paramType  = "header", dataType = "String", required=true)

3.swagger文档说明截图显示

4.swagger文档调试显示框

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。

赞 (0)

相关推荐

  • java swagger ui 添加header请求头参数的方法

    我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen. swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧. swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调 swagger codegen:主要用于通过swagger来自动生成代码 我用的swagger ui主要在java项目中.将所有的http接口提供

  • 如何使用RequestHeaders添加自定义参数

    如何使用RequestHeaders添加自定义参数

    目录 RequestHeaders添加自定义参数 问题一 原因 解决方案 修改request中header的值 RequestHeaders添加自定义参数 在开发过程中有的时候,参数需要绑定到requestHeaders中,而并不是在body中进行传输.这个时候就需要我们自己定义参数(需要后台的配合) setToken() { let token = localStorage.getItem('token') ? localStorage.getItem('token') : '' this.i

  • Spring Boot整合swagger使用教程详解

    Swagger的介绍

  • swagger中如何给请求添加header

    swagger中如何给请求添加header

    目录 如何给请求添加header 1.后台代码如下 2.添加后的swagger中接口样式如下 swagger添加头部参数 1.代码截图 2.使用代码 3.swagger文档说明截图显示 4.swagger文档调试显示框 如何给请求添加header 背景:在集成了swagger的项目中,调用后台接口往往会经过一些自定义的拦截器,而拦截器加了token限制的话,直接在swagger页面中请求后台接口会调不通,那么就需要在swagger中也设置请求token 1.后台代码如下 required(fal

  • 浅谈在fetch方法中添加header后遇到的预检请求问题

    今天在使用fetch方法 fetch('xxx.com',{header:{bbbbbbb:111}}) 浏览器返回的请求信息中,header变成了 :authority:koss.nocorp.me :method:OPTIONS :path:/?a=1 :scheme:https accept:*/* accept-encoding:gzip, deflate, br accept-language:zh-CN,zh;q=0.8 access-control-request-headers:

  • springcloud 中 zuul 修改请求参数信息的方法

    Zuul是Netflix出品的一个基于JVM路由和服务端的负载均衡器. Zuul功能: 认证 压力测试 金丝雀测试 动态路由 负载削减 安全 静态响应处理 主动/主动交换管理 Zuul的规则引擎允许通过任何JVM语言来编写规则和过滤器, 支持基于Java和Groovy的构建. 配置属性 zuul.max.host.connections 已经被两个新的配置属性替代, zuul.host.maxTotalConnections (总连接数)和 zuul.host.maxPerRouteConnec

  • 简单介绍HTTP请求方式中8种请求方法

    简单介绍 HTTP是超文本传输协议,其定义了客户端与服务器端之间文本传输的规范.HTTP默认使用80端口,这个端口指的是服务端的端口,而客户端使用的端口是动态分配的.当我们没有指定端口访问时,浏览器会默认帮我们添加80端口.我们也可以自己指定访问端口如:http://www.ip138.com:80. 需要注意的是,现在大多数访问都使用了HTTPS协议,而HTTPS的默认端口为443,如果使用80端口访问HTTPS协议的服务器可能会被拒绝. HTTP请求的方法:HTTP/1.1协议中共定义了八种

  • ajax请求添加自定义header参数代码

    我就废话不多说了,大家还是直接看代码吧~ $.ajax({ type: "post", url:"http://127.0.0.1:4564/bsky-app/template/testPost", contentType: "application/json;charset=utf-8", data :JSON.stringify({"bodyName":"sdfsdf","date"

  • 如何在Vue项目中使用axios请求

    在实际的项目中,和后台的数据交互是少不了的,我通常使用的是 axios 库,所以以下示例也是以 axios 为基础来进行封装的. 1.安装 首先是 npm 安装 axios 很简单:npm install axios 2.没有封装存在的问题 如果在没有封装接口的项目中,在文件中随处可以看到如下的接口调用方法: this.$axios.post("/user/add", { params: { name: this.name, age: this.age } }) .then(res =

  • 使用feign服务调用添加Header参数

    使用feign服务调用添加Header参数

    feign添加Header参数 @Configuration public class FeignConfiguration implements RequestInterceptor { private static final Logger logger = LoggerFactory.getLogger(FeignConfiguration.class); @Override public void apply(RequestTemplate template) { ServletRequ

  • spring cloud gateway中如何读取请求参数

    spring cloud gateway中如何读取请求参数

    spring cloud gateway读取请求参数 1. 我的版本: spring-cloud:Hoxton.RELEASE spring-boot:2.2.2.RELEASE spring-cloud-starter-gateway 2. 请求日志 import lombok.extern.slf4j.Slf4j; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springfram

  • java获取http请求的Header和Body的简单方法

    在http请求中,有Header和Body之分,读取header使用request.getHeader("..."); 读取Body使用request.getReader(),但getReader获取的是BufferedReader,需要把它转换成字符串,下面是转换的方法. public class TestController { @RequestMapping("/a") protected void doPost(HttpServletRequest requ

随机推荐