这篇文章主要介绍了swagger中如何给请求添加header,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
如何给请求添加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文档调试显示框
以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程学习网。
织梦狗教程
本文标题为:swagger中如何给请求添加header


基础教程推荐
猜你喜欢
- JVM分析之类加载机制详解 2023-04-06
- 一文了解Java 线程池的正确使用姿势 2023-06-17
- 用java实现扫雷游戏 2022-12-06
- Java使用EasyExcel进行单元格合并的问题详解 2023-01-18
- Java File类的概述及常用方法使用详解 2023-05-18
- SpringBoot配置文件中密码属性加密的实现 2023-03-11
- 工厂方法在Spring框架中的运用 2023-06-23
- 全局记录Feign的请求和响应日志方式 2023-01-09
- Java去掉小数点后面无效0的方案与建议 2023-02-18
- Project Reactor源码解析publishOn使用示例 2023-04-12