这篇文章主要介绍了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
基础教程推荐
猜你喜欢
- Java并发编程进阶之线程控制篇 2023-03-07
- JDK数组阻塞队列源码深入分析总结 2023-04-18
- Java数据结构之对象比较详解 2023-03-07
- Java文件管理操作的知识点整理 2023-05-19
- java基础知识之FileInputStream流的使用 2023-08-11
- Java实现查找文件和替换文件内容 2023-04-06
- springboot自定义starter方法及注解实例 2023-03-31
- ConditionalOnProperty配置swagger不生效问题及解决 2023-01-02
- Java实现线程插队的示例代码 2022-09-03
- java实现多人聊天系统 2023-05-19