boot spring 加入head_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 pars = new ArrayList();

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

版权声明：本文为博主原创文章，转载请附上博文链接！