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