cn.ziyicloud.framework.boot.autoconfigure.knife4j

类 ZiyiKnife4jAutoConfiguration

java.lang.Object

cn.ziyicloud.framework.boot.autoconfigure.knife4j.ZiyiKnife4jAutoConfiguration

所有已实现的接口:

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

@Configuration
 @EnableConfigurationProperties(value=ZiyiKnife4jProperties.class)
 @ConditionalOnClass(value={springfox.documentation.swagger.configuration.SwaggerCommonConfiguration.class,springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration.class,springfox.documentation.swagger2.web.Swagger2ControllerWebMvc.class})
 @ConditionalOnProperty(prefix="ziyi.knife4j",
                       name="enable",
                       havingValue="true",
                       matchIfMissing=true)
 @ComponentScan(basePackages="com.github.xiaoymin.knife4j.spring.plugin")
 @Import(value={springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration.class,springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})
public class ZiyiKnife4jAutoConfiguration
extends Object
implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Swagger2+Knife4j自动化配置

作者:

Li Ruitong

构造器概要

构造器

构造器和说明
ZiyiKnife4jAutoConfiguration(ZiyiKnife4jProperties knife4jProperties, org.springframework.beans.factory.BeanFactory beanFactory)

方法概要

限定符和类型	方法和说明
void	addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry registry) 通用拦截器排除swagger设置，所有拦截器都会自动加swagger相关的资源排除信息
springfox.documentation.spring.web.plugins.Docket	docket() 配置swagger基本信息 - BasePackage 默认使用SpringBoot项目扫描bean根目录 如果存在配置时则使用SwaggerProperties.basePackage作为扫描根目录
com.github.xiaoymin.knife4j.spring.model.MarkdownFiles	markdownFiles() 初始化自定义Markdown特性
com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter	productionSecurityFilter()
com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter	securityBasicAuthFilter()

从类继承的方法 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

构造器详细资料

ZiyiKnife4jAutoConfiguration

public ZiyiKnife4jAutoConfiguration(ZiyiKnife4jProperties knife4jProperties,
                                    org.springframework.beans.factory.BeanFactory beanFactory)

方法详细资料

docket

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

配置swagger基本信息 - BasePackage 默认使用SpringBoot项目扫描bean根目录 如果存在配置时则使用SwaggerProperties.basePackage作为扫描根目录

返回:

Docket实例

markdownFiles

@Bean(initMethod="init")
public com.github.xiaoymin.knife4j.spring.model.MarkdownFiles markdownFiles()

初始化自定义Markdown特性

返回:

markdownFiles

securityBasicAuthFilter

@Bean
public com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter securityBasicAuthFilter()

productionSecurityFilter

@Bean
public com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter productionSecurityFilter()

addInterceptors

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

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

指定者:

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