cn.ziyicloud.framework.boot.autoconfigure.doc.springdoc

类 ZiyiSpringdocAutoConfiguration

java.lang.Object

cn.ziyicloud.framework.boot.autoconfigure.doc.springdoc.ZiyiSpringdocAutoConfiguration

所有已实现的接口:

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

@Configuration
 @EnableConfigurationProperties(value={ZiyiSpringdocProperties.class,ZiyiSwaggerProperties.class})
 @ConditionalOnClass(value=org.springdoc.webmvc.core.SpringDocWebMvcConfiguration.class)
public class ZiyiSpringdocAutoConfiguration
extends Object
implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer

springdoc+Knife4j-springdoc-ui自动化配置

从以下版本开始:

1.0.7

作者:

Li Ruitong 86415270@qq.com

构造器概要

构造器

构造器和说明
ZiyiSpringdocAutoConfiguration()

方法概要

限定符和类型	方法和说明
void	addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry registry) 通用拦截器排除swagger设置，所有拦截器都会自动加swagger相关的资源排除信息
io.swagger.v3.oas.models.OpenAPI	ziyiOpenApi(ZiyiSwaggerProperties swaggerProperties) Ziyi Boot 自定义OpenAPI

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

构造器详细资料

ZiyiSpringdocAutoConfiguration

public ZiyiSpringdocAutoConfiguration()

方法详细资料

ziyiOpenApi

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnProperty(name="ziyi.doc.swagger.auto",
                       havingValue="true",
                       matchIfMissing=true)
public io.swagger.v3.oas.models.OpenAPI ziyiOpenApi(ZiyiSwaggerProperties swaggerProperties)

Ziyi Boot 自定义OpenAPI

参数:

swaggerProperties - swagger 配置信息

返回:

OpenAPI

addInterceptors

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

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

指定者:

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