java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > swagger请求添加header

swagger中如何给请求添加header

作者:Anyhowe

这篇文章主要介绍了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文档调试显示框

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

您可能感兴趣的文章:
阅读全文