-
引入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> -
编写SwaggerConfig配置类
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
//apiInfo指定测试文档基本信息,这部分将在页面展示
.apiInfo(apiInfo())
.select()
//apis() 控制哪些接口暴露给swagger,
// RequestHandlerSelectors.any() 所有都暴露
// RequestHandlerSelectors.basePackage("com.info.*") 指定包位置
.apis(RequestHandlerSelectors.basePackage("com.yun.cloud.gap.controller"))
.paths(PathSelectors.any())
.build();
}
//基本信息,页面展示
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("GAP")
.description("GAP-小程序端接口描述")
//联系人实体类
.contact(
new Contact("名字", "网址", "邮箱")
)
//版本号
.version("1.0.0-SNAPSHOT")
.build();
}
}
-
配置拦截器,防止把swagger页面过滤
registry.addInterceptor(new LoginInterceptor(cacheServiceRedis)) .addPathPatterns("/**") .excludePathPatterns("/user/login","/user/register","/sms/send","/user/changePass") .excludePathPatterns("/swagger-ui.html") .excludePathPatterns("/**/swagger-ui/**") .excludePathPatterns("/v2/api-docs") .excludePathPatterns("/**/swagger-resources/**"); -
登录:

















