Commit f152f3e5 by huluobin

update

parent efd445b3
......@@ -27,6 +27,38 @@ import java.util.List;
@EnableSwagger2
public class Swagger2Config {
// /**
// * 创建API应用
// * apiInfo() 增加API相关信息
// * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
// * 本例采用指定扫描的包路径来定义指定要建立API的目录。
// *
// * @return
// */
// @Bean
// public Docket createRestApi() {
//
// //添加head参数配置start
// ParameterBuilder tokenPar = new ParameterBuilder();
// List<Parameter> pars = new ArrayList<>();
// tokenPar.name("token")
// .description("登陆凭证")
// .modelRef(new ModelRef("string"))
// .parameterType("header").required(false)
// .build();
//
// pars.add(tokenPar.build());
//
// return new Docket(DocumentationType.SWAGGER_2)
// .apiInfo(apiInfo())
// .select()
// .apis(RequestHandlerSelectors.basePackage("com.gogirl"))
// .paths(PathSelectors.any())
// .build()
// .globalOperationParameters(pars);//注意这里
// }
/**
* 创建API应用
* apiInfo() 增加API相关信息
......@@ -37,26 +69,28 @@ public class Swagger2Config {
*/
@Bean
public Docket createRestApi() {
//添加head参数配置start
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("token")
.description("登陆凭证")
.modelRef(new ModelRef("string"))
.parameterType("header").required(false)
.parameterType("sourceFrom").required(true).build();
pars.add(tokenPar.build());
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.gogirl"))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);//注意这里
.globalOperationParameters(defaultHeader())
;
}
private static List<Parameter> defaultHeader() {
ParameterBuilder appType = new ParameterBuilder();
appType.name("sourceFrom").description("应用类型").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
ParameterBuilder appToken = new ParameterBuilder();
appToken.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
List<Parameter> pars = new ArrayList<>();
pars.add(appType.build());
pars.add(appToken.build());
return pars;
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中)
* 访问地址:http://项目实际地址/swagger-ui.html
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment