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

 更新时间:2019年08月29日 10:49:55   作者:大伟爱自由  
今天小编就为大家分享一篇java swagger ui 添加header请求头参数的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen。

swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧。

swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调

swagger codegen:主要用于通过swagger来自动生成代码

我用的swagger ui主要在java项目中。将所有的http接口提供一个可视化页面。供前端同学看到,联调非常方便,所有的接口一目了然。

但是在使用swagger ui的时候,我有一个新的需求,就是我所有的接口都必须授权才能访问,即每个接口都必须添加一个header里的参数。一般用Authorization,但是我的键是ticket。于是尝试配置swagger,将每个接口都默认增加一个ticket的请求参数。

我在Java中用的swagger框架是springfox。springfox是比较新的,官方也一直在更新。java添加swagger我就不详细介绍了,这里只介绍如何在所有的swagger接口中默认都添加header参数

粘贴springfox配置如下:

package cn.ce.platform_service.interceptors;
 
import java.util.ArrayList;
import java.util.List;
 
import org.springframework.context.annotation.Bean;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
/**
* @Description : swagger配置配置
* @Author : Mars
* @Date : 2017年9月6日
*/
@WebAppConfiguration
@EnableSwagger2
@EnableWebMvc
//@ComponentScan(basePackageClasses = {ApisController.class }) //Instructs spring where to scan for API controllers
public class SwaggerConfig {
	
  /**
   * Every Docket bean is picked up by the swagger-mvc framework - allowing for multiple
   * swagger groups i.e. same code base multiple swagger resource listings.
   */
  @Bean
  public Docket customDocket(){
  	ParameterBuilder ticketPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<Parameter>(); 
  	ticketPar.name("ticket").description("user ticket")
  	.modelRef(new ModelRef("string")).parameterType("header") 
  	.required(false).build(); //header中的ticket参数非必填,传空也可以
  	pars.add(ticketPar.build());  //根据每个方法名也知道当前方法在设置什么参数
 
    return new Docket(DocumentationType.SWAGGER_2)
    		.select()
    		.apis(RequestHandlerSelectors.any()) 
        .build() 
        .globalOperationParameters(pars) 
        .apiInfo(apiInfo());
  }
  
  ApiInfo apiInfo() { 
  	return new ApiInfoBuilder() 
      .title("api swagger document") 
      .description("前后端联调swagger api 文档") 
      .version("2.1.5.5") 
      .build();
  } 
}

修改swagger的配置文件如上即能满足swagger中所有的接口默认都加上ticket参数,非必填如下图:

以上这篇java swagger ui 添加header请求头参数的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 深入理解Spring的事务传播行为

    深入理解Spring的事务传播行为

    spring特有的事务传播行为,spring支持7种事务传播行为,确定客户端和被调用端的事务边界(说得通俗一点就是多个具有事务控制的service的相互调用时所形成的复杂的事务边界控制),这篇文章主要给大家介绍了关于Spring事务传播行为的相关资料,需要的朋友可以参考下。
    2018-02-02
  • 深入浅析hbase的优点

    深入浅析hbase的优点

    本文讲述了HBase的特征和它的优点,并简要回顾了行键设计的重点之处,它还向你展示了如何在本地配置HBase环境,使用命令创建表、插入数据、检索指定行以及最后如何进行scan操作,感兴趣的朋友一起看看吧
    2017-09-09
  • 基于java中BlockingQueue的使用介绍

    基于java中BlockingQueue的使用介绍

    本篇文章小编为大家介绍,基于java中BlockingQueue的使用介绍。需要的朋友参考下
    2013-04-04
  • 详解Java CompletableFuture使用方法以及与FutureTask的区别

    详解Java CompletableFuture使用方法以及与FutureTask的区别

    CompletableFuture实现了CompletionStage接口和Future接口,前者是对后者的一个扩展,增加了异步回调、流式处理、多个Future组合处理的能力,使Java在处理多任务的协同工作时更加顺畅便利
    2021-10-10
  • Java基础之Filter的实例详解

    Java基础之Filter的实例详解

    这篇文章主要介绍了Java基础之Filter的实例详解的相关资料,需要的朋友可以参考下
    2017-07-07
  • Springcloud feign传日期类型参数报错的解决方案

    Springcloud feign传日期类型参数报错的解决方案

    这篇文章主要介绍了Springcloud feign传日期类型参数报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • SpringBoot预加载与懒加载实现方法超详细讲解

    SpringBoot预加载与懒加载实现方法超详细讲解

    Spring一直被诟病启动时间慢,可Spring/SpringBoot是轻量级的框架。因为当Spring项目越来越大的时候,在启动时加载和初始化Bean就会变得越来越慢,很多时候我们在启动时并不需要加载全部的Bean,在调用时再加载就行,那这就需要预加载与懒加载的功能了
    2022-11-11
  • java反射遍历实体类属性和类型,并赋值和获取值的简单方法

    java反射遍历实体类属性和类型,并赋值和获取值的简单方法

    下面小编就为大家带来一篇java反射遍历实体类属性和类型,并赋值和获取值的简单方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • SpringBoot整合SpringSecurity和JWT和Redis实现统一鉴权认证

    SpringBoot整合SpringSecurity和JWT和Redis实现统一鉴权认证

    Spring Security是一个可以为Java应用程序提供全面安全服务的框架,同时它也可以轻松扩展以满足自定义需求,本文主要介绍了SpringBoot整合SpringSecurity和JWT和Redis实现统一鉴权认证,感兴趣的可以了解一下
    2023-11-11
  • 基于java中正则操作的方法总结

    基于java中正则操作的方法总结

    本篇文章介绍了,在java中正则操作的方法总结。需要的朋友参考下
    2013-05-05

最新评论