package com.zbinyds.gradle.config;
import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* @author zbinyds
* @time 2022/09/13 17:22
*
* 项目集成swagger2,进行接口测试
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* swagger文档相关配置
* @return
*/
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
// .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build()
.globalOperationParameters(getParameterList()); //添加全局配置,head参数
}
/**
* api基本信息配置
* @return
*/
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("项目-API文档")
.description("本文档描述了项目中所有接口的定义")
.version("1.0")
.contact(new Contact("Zbinyds", "http://xxx.com", "zbinyds@gmail.com"))
.build();
}
/**
* 添加head参数配置
* @return
*/
private List<Parameter> getParameterList() {
ParameterBuilder clientIdTicket = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
clientIdTicket.name("token").description("token令牌")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false).build(); //设置false,表示clientId参数 非必填,可传可不传!
pars.add(clientIdTicket.build());
return pars;
}
}
在swagger2中添加请求头参数
最新推荐文章于 2024-07-03 08:49:21 发布