cn.ziyicloud.framework.boot.autoconfigure.doc.springfox

类 ZiyiSpringfoxAutoConfiguration

java.lang.Object

cn.ziyicloud.framework.boot.autoconfigure.doc.springfox.ZiyiSpringfoxAutoConfiguration

所有已实现的接口:

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

@Configuration
 @EnableConfigurationProperties(value={ZiyiSpringfoxProperties.class,ZiyiSwaggerProperties.class})
 @ConditionalOnClass(value=springfox.documentation.swagger2.configuration.Swagger2DocumentationWebMvcConfiguration.class)
 @Import(value=springfox.documentation.swagger2.configuration.Swagger2DocumentationWebMvcConfiguration.class)
 @ComponentScan(basePackages="com.github.xiaoymin.knife4j.spring.plugin")
public class ZiyiSpringfoxAutoConfiguration
extends Object
implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Swagger2+Knife4j自动化配置

从以下版本开始:

1.0.0, 1.0.0

作者:

Li Ruitong 86415270@qq.com

构造器概要

构造器

构造器和说明
ZiyiSpringfoxAutoConfiguration()

方法概要

限定符和类型	方法和说明
void	addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry registry) 通用拦截器排除swagger设置，所有拦截器都会自动加swagger相关的资源排除信息
org.springframework.web.filter.CorsFilter	corsFilter()
com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver	markdownResolver(ZiyiSpringfoxProperties knife4jProperties)
com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter	productionSecurityFilter(ZiyiSpringfoxProperties knife4jProperties)
com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter	securityBasicAuthFilter(ZiyiSpringfoxProperties knife4jProperties)
springfox.documentation.spring.web.plugins.Docket	ziyiApi(ZiyiSpringfoxProperties knife4jProperties, ZiyiSwaggerProperties swaggerProperties)

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

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

构造器详细资料

ZiyiSpringfoxAutoConfiguration

public ZiyiSpringfoxAutoConfiguration()

方法详细资料

ziyiApi

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.swagger.auto",
                       havingValue="true",
                       matchIfMissing=true)
public springfox.documentation.spring.web.plugins.Docket ziyiApi(ZiyiSpringfoxProperties knife4jProperties,
                                                                                                                                                                                                                                                    ZiyiSwaggerProperties swaggerProperties)

corsFilter

@Bean(value="ziyiKnife4jCorsFilter")
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.knife4j.cors",
                       havingValue="true")
public org.springframework.web.filter.CorsFilter corsFilter()

markdownResolver

@Bean(initMethod="start",
      value="ziyiKnife4jOpenApiExtensionResolver")
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.knife4j.enabled",
                       havingValue="true")
public com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver markdownResolver(ZiyiSpringfoxProperties knife4jProperties)

securityBasicAuthFilter

@Bean(value="ziyiKnife4jSecurityBasicAuthFilter")
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.knife4j.basic.enabled",
                       havingValue="true")
public com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter securityBasicAuthFilter(ZiyiSpringfoxProperties knife4jProperties)

productionSecurityFilter

@Bean(value="ziyiKnife4jProductionSecurityFilter")
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.knife4j.production",
                       havingValue="true")
public com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter productionSecurityFilter(ZiyiSpringfoxProperties knife4jProperties)

addInterceptors

public void addInterceptors(@Nonnull
                            org.springframework.web.servlet.config.annotation.InterceptorRegistry registry)

通用拦截器排除swagger设置，所有拦截器都会自动加swagger相关的资源排除信息

指定者:

addInterceptors 在接口中 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

参数:

registry - 注册表