springboot集成swagger添加消息頭（header請求頭信息）

springboot集成swagger上篇文章介紹：

        https://blog.csdn.net/qiaorui_/article/details/80435488

添加頭信息：

package com.rails.travel.conf;

import java.util.ArrayList;
import java.util.List;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
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;

/**
* swagger配置類
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig{

@Bean
public Docket createRestApi() {

        //在配置好的配置類中增長此段代碼便可
ParameterBuilder ticketPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
ticketPar.name("Authorization").description("登陸校驗")//name表示名稱，description表示描述
.modelRef(new ModelRef("string")).parameterType("header")
.required(false).defaultValue("Bearer ").build();//required表示是否必填，defaultvalue表示默認值
pars.add(ticketPar.build());//添加完此處必定要把下邊的帶***的也加上不然不生效

return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //這裏採用包含註解的方式來肯定要顯示的接口
//.apis(RequestHandlerSelectors.basePackage("com.stylefeng.guns.modular.system.controller")) //這裏採用包掃描的方式來肯定要顯示的接口
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);//************把消息頭添加
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("travel-admin-ws Doc")
.description("travel-admin-web Api文檔")
.termsOfServiceUrl("")
.version("1.0")
.build();
}

}
結果以下：

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