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请求头参数的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java实现扑克牌程序

    Java实现扑克牌程序

    这篇文章主要为大家详细介绍了Java实现扑克牌程序,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-10-10
  • 浅谈Java中的class类

    浅谈Java中的class类

    这篇文章主要介绍了浅谈Java中的class类,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • java 中String.equals和==的比较

    java 中String.equals和==的比较

    这篇文章主要介绍了java 中String.equals和==的比较的相关资料,需要的朋友可以参考下
    2017-08-08
  • SpringMVC请求参数的使用总结

    SpringMVC请求参数的使用总结

    在日常使用SpringMVC进行开发的时候,有可能遇到前端各种类型的请求参数,本文主要接介绍了SpringMVC请求参数的使用总结,感兴趣的可以了解一下
    2021-06-06
  • 深入浅析MyBatis foreach标签

    深入浅析MyBatis foreach标签

    Mybatis foreach 标签用于循环语句,它很好的支持了数据和 List、set 接口的集合,并对此提供遍历的功能,本文给大家介绍MyBatis foreach标签的相关知识,感兴趣的朋友一起看看吧
    2021-09-09
  • SpringBoot发送html邮箱验证码功能

    SpringBoot发送html邮箱验证码功能

    这篇文章主要介绍了SpringBoot发送html邮箱验证码,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-12-12
  • Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍(最新推荐)

    Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍(最新推荐)

    RequestMappingHandlerMapping接口是Spring MVC中的一个核心组件,负责处理请求映射和处理器的匹配这篇文章主要介绍了Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍,需要的朋友可以参考下
    2024-07-07
  • 详解Java中如何定义和访问静态字段和方法

    详解Java中如何定义和访问静态字段和方法

    在面向对象的程序设计中,我们通常使用类来创建对象,类中有许多成员变量和方法,它们是直接属于对象实例的,与之对应的还有一类成员,那就是静态成员,本文就来和大家聊聊Java是如何定义访问静态成员的吧
    2023-05-05
  • Java8接口默认静态方法及重复注解原理解析

    Java8接口默认静态方法及重复注解原理解析

    这篇文章主要介绍了Java8接口默认静态方法及重复注解原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Java ZooKeeper分布式锁实现图解

    Java ZooKeeper分布式锁实现图解

    ZooKeeper是一个分布式的,开放源码的分布式应用程序协调服务,是Google的Chubby一个开源的实现,是Hadoop和Hbase的重要组件。它是一个为分布式应用提供一致性服务的软件,提供的功能包括:配置维护、域名服务、分布式同步、组服务等
    2022-03-03

最新评论