56 lines
2.1 KiB
Java
56 lines
2.1 KiB
Java
package com.atguigu.auth.config;
|
|
|
|
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
|
|
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.builders.RequestHandlerSelectors;
|
|
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 java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
@Configuration
|
|
@EnableKnife4j
|
|
public class Knife4jConfig {
|
|
@Bean
|
|
public Docket adminApiConfig() {
|
|
List<Parameter> pars = new ArrayList<>();
|
|
ParameterBuilder tokenPar = new ParameterBuilder();
|
|
tokenPar.name("token")
|
|
.description("用户token")
|
|
.defaultValue("")
|
|
.modelRef(new ModelRef("string"))
|
|
.parameterType("header")
|
|
.required(false)
|
|
.build();
|
|
pars.add(tokenPar.build());
|
|
// 添加head参数end
|
|
|
|
return new Docket(DocumentationType.SWAGGER_2)
|
|
.groupName("adminApi")
|
|
.apiInfo(adminApiInfo())
|
|
.select()
|
|
// 只显示admin路径下的页面
|
|
.apis(RequestHandlerSelectors.basePackage("com.atguigu"))
|
|
.paths(PathSelectors.ant("/admin/**"))// PathSelectors.regex("/admin/.*")
|
|
.build()
|
|
.globalOperationParameters(pars);
|
|
}
|
|
|
|
private ApiInfo adminApiInfo() {
|
|
return new ApiInfoBuilder()
|
|
.title("后台管理系统-API文档")
|
|
.description("本文档描述了后台管理系统微服务接口定义")
|
|
.version("1.0")
|
|
.contact(new Contact("atguigu", "http://atguigu.com", "atguigu@qq.com"))
|
|
.build();
|
|
}
|
|
} |