com.yishuifengxiao.common.swagger

Class Swagger2AutoConfiguration

java.lang.Object

com.yishuifengxiao.common.swagger.Swagger2AutoConfiguration

All Implemented Interfaces:

org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@Configuration
 @EnableSwagger2
 @EnableSwaggerBootstrapUI
 @EnableConfigurationProperties(value=SwaggerProperties.class)
 @ConditionalOnProperty(prefix="yishuifengxiao.swagger",
                       name="base-package")
public class Swagger2AutoConfiguration
extends Object
implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer

swagger扩展支持自动配置

Since:

1.0.0

Version:

1.0.0

Author:

yishui

Constructor Summary

Constructors

Constructor and Description
Swagger2AutoConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry) 配置静态资源路径,防止出现访问swagger-ui界面时出现404
void	addViewControllers(org.springframework.web.servlet.config.annotation.ViewControllerRegistry registry)
void	checkConfig() 配置检查
springfox.documentation.spring.web.plugins.Docket	createRestApi() swagger-ui配置
javax.servlet.Filter	swaggerAuthFilter(SwaggerProperties swaggerProperties) 配置swagger文档访问权限认证

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addReturnValueHandlers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Constructor Detail

Swagger2AutoConfiguration

public Swagger2AutoConfiguration()

Method Detail

addResourceHandlers

public void addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)

配置静态资源路径,防止出现访问swagger-ui界面时出现404

Specified by:

addResourceHandlers in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

addViewControllers

public void addViewControllers(org.springframework.web.servlet.config.annotation.ViewControllerRegistry registry)

Specified by:

addViewControllers in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

createRestApi

@Bean
 @ConditionalOnMissingClass
public springfox.documentation.spring.web.plugins.Docket createRestApi()

swagger-ui配置

Returns:

Docket实例

swaggerAuthFilter

@Bean
public javax.servlet.Filter swaggerAuthFilter(SwaggerProperties swaggerProperties)

配置swagger文档访问权限认证

Parameters:

swaggerProperties - swagger扩展支持属性配置

Returns:

swagger文档访问权限认证过滤器

checkConfig

@PostConstruct
public void checkConfig()

配置检查