java swagger ui 添加header請求頭參數(shù)的方法

更新時(shí)間：2019年08月29日 10:49:55 作者：大偉愛自由

今天小編就為大家分享一篇java swagger ui 添加header請求頭參數(shù)的方法，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧

我用到的swagger 主要有三款產(chǎn)品，swagger editor，swagger ui 和swagger codegen。

swagger editor：主要是一個(gè)本地客戶端，用來自己添加api，自己來測試，相當(dāng)于一個(gè)api的可視化測試工具和定義工具吧。

swagger ui：主要用戶嵌入到項(xiàng)目中，將所有的接口生成一個(gè)可視化的頁面，方便前后端聯(lián)調(diào)

swagger codegen：主要用于通過swagger來自動生成代碼

我用的swagger ui主要在java項(xiàng)目中。將所有的http接口提供一個(gè)可視化頁面。供前端同學(xué)看到，聯(lián)調(diào)非常方便，所有的接口一目了然。

但是在使用swagger ui的時(shí)候，我有一個(gè)新的需求，就是我所有的接口都必須授權(quán)才能訪問，即每個(gè)接口都必須添加一個(gè)header里的參數(shù)。一般用Authorization，但是我的鍵是ticket。于是嘗試配置swagger，將每個(gè)接口都默認(rèn)增加一個(gè)ticket的請求參數(shù)。

我在Java中用的swagger框架是springfox。springfox是比較新的，官方也一直在更新。java添加swagger我就不詳細(xì)介紹了，這里只介紹如何在所有的swagger接口中默認(rèn)都添加header參數(shù)

粘貼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參數(shù)非必填，傳空也可以
  	pars.add(ticketPar.build());  //根據(jù)每個(gè)方法名也知道當(dāng)前方法在設(shè)置什么參數(shù)
 
    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("前后端聯(lián)調(diào)swagger api 文檔") 
      .version("2.1.5.5") 
      .build();
  } 
}

修改swagger的配置文件如上即能滿足swagger中所有的接口默認(rèn)都加上ticket參數(shù)，非必填如下圖：