程序包 top.continew.starter.apidoc.autoconfigure

类 SpringDocAutoConfiguration

java.lang.Object
top.continew.starter.apidoc.autoconfigure.SpringDocAutoConfiguration
所有已实现的接口:
org.springframework.web.servlet.config.annotation.WebMvcConfigurer
@EnableWebMvc @AutoConfiguration @ConditionalOnProperty(prefix="springdoc.swagger-ui", name="enabled", havingValue="true") @EnableConfigurationProperties(SpringDocExtensionProperties.class) @PropertySource(value="classpath:default-api-doc.yml", factory=top.continew.starter.core.util.GeneralPropertySourceFactory.class) public class SpringDocAutoConfiguration extends Object implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer
API 文档自动配置
从以下版本开始:
1.0.0
作者:
Charles7c

  • 构造器概要

    构造器
    构造器
    说明
    SpringDocAutoConfiguration()
     

  • 方法概要

    修饰符和类型
    方法
    说明
    void
    addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)
     
    org.springdoc.core.customizers.GlobalOpenApiCustomizer
    globalOpenApiCustomizer(SpringDocExtensionProperties properties)
    全局自定义配置（全局添加鉴权参数）
    io.swagger.v3.oas.models.OpenAPI
    openApi(ProjectProperties projectProperties, SpringDocExtensionProperties properties)
    Open API 配置
    void
    postConstruct()
     

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

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

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

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

  • 构造器详细资料

    • SpringDocAutoConfiguration

      public SpringDocAutoConfiguration()

  • 方法详细资料

    • addResourceHandlers

      public void addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)
      指定者:
      addResourceHandlers 在接口中 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

    • openApi

      @Bean @ConditionalOnMissingBean public io.swagger.v3.oas.models.OpenAPI openApi(ProjectProperties projectProperties, SpringDocExtensionProperties properties)
      Open API 配置

    • globalOpenApiCustomizer

      @Bean public org.springdoc.core.customizers.GlobalOpenApiCustomizer globalOpenApiCustomizer(SpringDocExtensionProperties properties)
      全局自定义配置（全局添加鉴权参数）

    • postConstruct

      @PostConstruct public void postConstruct()