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參數，非必填以下圖：

 

---------------------
做者：uncle_david
來源：CSDN
原文：https://blog.csdn.net/uncle_david/article/details/79283422
版權聲明：本文爲博主原創文章，轉載請附上博文連接！