swagger2 携带多个请求头

最新推荐文章于 2024-06-04 21:56:44 发布
最新推荐文章于 2024-06-04 21:56:44 发布
阅读量3.8k 收藏 2
点赞数
文章标签： swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/aiguo94/article/details/99873920
版权
本文介绍了如何在Swagger2中配置携带多个请求头，解决了可能出现的参数覆盖问题。通过示例代码和配置说明，展示了正确设置多个Header参数的方法，并提到了解决Swagger展示错误的解决方案。
摘要由CSDN通过智能技术生成

有看到网上文章说当header需要多个参数的时候，新建多个 ParameterBuilder，经过测试，重复使用一个ParameterBuilder会出现后面覆盖前面的情况。
我没有出现这种情况，以下是SwaggerConfig 的代码，以及效果图。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Value("${swagger.enable:false}")
    private boolean enable=false;


    @Bean
    public Docket createRestApi() {
        //添加head参数配置start
        ParameterBuilder tokenPar1 = new ParameterBuilder();
        ParameterBuilder tokenPar2 = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar1.name("token1")
                .description("请求头1")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(true)
                .build();
        tokenPar2.name("token2")
                .description("请求头2")
                .modelRef(new ModelRef("st
最低0.47元/天 解锁文章
SmileHan666
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Net.WebApi_JWT_Swagger_Autofac.zip
09-11
综上所述，这个项目涵盖了现代WebAPI开发中的多个关键组件和技术，包括API文档、安全身份验证、依赖注入、ORM工具与数据库交互，以及领域驱动设计的实践，为构建健壮且易于维护的API提供了基础。通过深入学习和理解...
IDEA+Springboot+Mybatis+MySql+Swagger3.0+JWT权限验证 的实现 增、删、改、查
09-03
每个请求会携带JWT Token，服务器端通过解码Token来判断用户权限。 在实现上述功能的过程中，我们需要编写Controller层的代码来处理HTTP请求，Service层的代码来封装业务逻辑，Mapper层的代码来对接Mybatis执行SQL...
java swagger ui 添加header请求头参数的方法
08-25
今天小编就为大家分享一篇java swagger ui 添加header请求头参数的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
设置请求头信息的不同方式
djp0910的博客
08-03 932
原文：http://blog.csdn.net/magiclr/article/details/49643277 在AngularJs中有三种方式可以设置请求头信息： 1、在http服务的服务端发送请求时，也就是调用http()方法时，在config对象中设置请求头信息： $http.post('/somePath' , someData , { heade...
swagger2显示错误解决:Could not render e, see the console.
最新发布
2301_79437276的博客
06-04 728
同时可以根据environment去处配置要给那些开发环境设置swagger文档，底层会通过扫描配置文件中的active来判断当前的开发环境。环境符合则flag返回true，false则会显示不可用。出现这种情况就是swagger的配置类出了问题，在.enable()中传入了false。active: pro #dev(开发) #pro(生产)
angular7的httpClient中添加多个请求头问题
yw00yw的博客
07-03 9110
在使用angular的httpClient模块中，post提交需要设置请求头。 初始设置如下： const httpOptions = { headers: new HttpHeaders({ 'Content-Type': 'application/json' }) }; 因为后台使用的是c# web api，如果这样设置的话，谷歌浏览器可以登录成功，但是其他浏览器比...
【开发日记】Swagger添加全局Header参数
二饭的博客
09-19 1904
设置自定义的header参数，并要求使用人在测试接口时必须填写相应参数。
java中参数加..._Swagger中统一添加参数
weixin_42364609的博客
02-24 1204
Swagger简介说起Swagger，真是后台API开发的利器，在没有前端页面的情况下，很方便的就可以进行后台逻辑的测试。一般来说，在spring mvc工程中使用了Swagger，它会自动扫描controller中的参数，在Swagger的页面中进行显示。例如有如下代码：@GetMapping("bar")public String bar(String bar) {return bar;}则会...
WeApi多版本.rar
11-30
WebApi多版本控制是开发RESTful API时常常面临的一个挑战，尤其在系统升级或扩展功能时，需要确保旧版本API的兼容性。本压缩包"WebApi多版本.rar"提供的内容，显然是关于如何在C#和ASP.NET环境下利用Swagger来实现...
springBoot-restful-angular：springBoot，restful，jwt，angular4构造的前替代分离后台管理系统
02-04
总结来说，"springBoot-restful-angular"项目是一个集成了多个先进技术的后台管理系统，旨在提供高效、安全和易用的用户体验。通过理解这些技术的原理和用法，开发者可以更好地理解和维护这个系统。
Laravel开发-token-auth
08-28
在Laravel框架中，Token-based Authentication（令牌认证）是一种常见的API认证方式，它不依赖于传统的Session机制，而是通过在请求头中携带一个令牌来验证用户身份。这种认证方式适用于前后端分离的应用或者移动...
SpringBoot 2.2.5 整合Swagger 2.9.2，实现扫描多个不同包的接口，并配置支持传参Token进行验证
qq_43659871的博客
12-20 1072
【代码】SpringBoot 2.2.5 整合Swagger 2.9.2，实现扫描多个不同包的接口，并配置支持传参Token进行验证。
Swagger2 | 08.Swagger中为请求添加header
xyx-Eshang的博客
09-01 4190
0.参考文章 swagger中给请求添加header 1.修改SwaggerConfig.java 1.1.添加getParameterList()方法 本质是添加全局参数，这里特定地将这个全局参数的类型设置为请求头(header) public List<Parameter> getParameterList() { ParameterBuilder token = new ParameterBuilder(); List<Parameter> params = new
SwaggerUI增加公共的Global全局Header
铁锚的CSDN博客
05-06 3321
为了调试方便, 想要在 SwaggerUI 的 "Try it out" 页面中增加一个认证 Header, 一个个接口添加注解就太麻烦了，有没有什么方式可以全局生成呢? 网上找了很多资料都不生效, 最后终于搞定了, 所以才有了这篇文章。
Swagger2的配置
lmxx9939的博客
06-06 1990
使用Swagger 2是为了解决前后端接口之间的交互问题提示：以下是本篇文章正文内容，下面案例可供参考后面扩展的方法是为了实现这两个方法我们需要了解这两个方法的作用：securityContexts 和 securitySchemes 是用于配置 Swagger 文档中的安全认证信息的两个关键部分。securityContexts：安全上下文securityContexts 方法用于配置需要进行安全认证的路径和相应的安全引用。
swagger2的配置以及注解，超详细！！
热门推荐
阿沐沐的博客
06-16 1万+
swagger配置以及注解 依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId>
SwaggerConfig 使用小技巧
wuzhenwei0419的博客
11-16 7448
@Configuration @EnableSwagger2 @EnableAutoConfiguration public class SwaggerConfig { @Bean public Docket createRestApi() { ParameterBuilder tokenPar = new ParameterBuilder(); ...
如何给swagger加请求头的三种方法 @ApiImplicitParam @Header 单方法和全局
爱学习的大雄的博客
11-04 8172
swagger提供的注解, 手动配置,就在controller某个接口方法上,类似@ApiOperation的位置,上下都可以。spring提供的注解,类似@RequestParam, 加在请求参数中, 也是可以直接帮你套进来,这个参数还可以拿来用。在自动生成的api文档中，我需要提供存在请求头中的token，所以就需要swagger去自动生成。修改swaggerConfig。
Swagger2中配置添加全局header
csdn_life18的博客
03-30 1902
引入maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</gro
authorization_Swagger2自动添加Authorization请求头
05-20
Swagger2 可以通过添加全局请求参数的方式来自动添加 Authorization 请求头。具体步骤如下： 1. 创建一个拦截器类，用于在请求头中添加 Authorization 参数。 ```java public class AuthInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String token = "your_token_here"; request.addHeader("Authorization", token); return true; } // 省略其他方法 } ``` 2. 在 Swagger2 配置类中添加全局请求参数。 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private AuthInterceptor authInterceptor; @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()) .globalOperationParameters(Collections.singletonList(new ParameterBuilder() .name("Authorization") .description("Authorization token") .modelRef(new ModelRef("string")) .parameterType("header") .required(true) .build())) .securityContexts(Collections.singletonList(SecurityContext.builder() .securityReferences(Collections.singletonList(SecurityReference.builder() .reference("Authorization") .scopes(new AuthorizationScope[0]) .build())) .build())) .securitySchemes(Collections.singletonList(new ApiKey("Authorization", "Authorization", "header"))); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API") .description("API documentation") .version("1.0") .build(); } // 添加拦截器 @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(authInterceptor); } } ``` 在这里我们使用 `globalOperationParameters` 方法添加一个全局请求参数，该参数名为 `Authorization`，类型为 `header`，并且是必须的。我们还需要使用 `securityContexts` 和 `securitySchemes` 方法来配置 Swagger2 使用该参数作为授权信息。 当我们访问 Swagger2 文档时，会自动向请求头中添加 Authorization 参数。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值