Package org.springdoc.webflux.ui

Class SwaggerWebFluxConfigurer

java.lang.Object
org.springdoc.ui.AbstractSwaggerConfigurer
org.springdoc.webflux.ui.SwaggerWebFluxConfigurer
All Implemented Interfaces:
org.springframework.web.reactive.config.WebFluxConfigurer
public class SwaggerWebFluxConfigurer extends org.springdoc.ui.AbstractSwaggerConfigurer implements org.springframework.web.reactive.config.WebFluxConfigurer
The type Swagger web flux configurer.
Author:
bnasslahsen

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springdoc.ui.AbstractSwaggerConfigurer

    org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerWebFluxConfigurer(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfigProperties, org.springframework.boot.autoconfigure.web.WebProperties springWebProperties, org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties springWebFluxProperties, SwaggerIndexTransformer swaggerIndexTransformer, SwaggerResourceResolver swaggerResourceResolver, SwaggerWelcomeCommon swaggerWelcomeCommon)
    Instantiates a new Swagger web flux configurer.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry registry)
     
    protected void
    addSwaggerResourceHandler(org.springframework.web.reactive.config.ResourceHandlerRegistry registry, org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig handlerConfig)
    Add a resource handler that uses the Swagger resource resolver and transformer.
    protected void
    addSwaggerResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry registry, org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig... handlerConfigs)
    Add resource handlers that use the Swagger resource resolver and transformer.
    protected org.springframework.cache.Cache
    getCache()
    Gets the Swagger resource chain cache.
    protected String
    getUiRootPath()
     
    protected String
    getWebjarsPathPattern()
     

    Methods inherited from class org.springdoc.ui.AbstractSwaggerConfigurer

    combinePatterns, getSwaggerHandlerConfigs, getSwaggerWebjarHandlerConfigs

    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.reactive.config.WebFluxConfigurer

    addCorsMappings, addErrorResponseInterceptors, addFormatters, configureArgumentResolvers, configureBlockingExecution, configureContentTypeResolver, configureHttpMessageCodecs, configurePathMatching, configureViewResolvers, getMessageCodesResolver, getValidator, getWebSocketService

  • Constructor Details

    • SwaggerWebFluxConfigurer

      public SwaggerWebFluxConfigurer(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfigProperties, org.springframework.boot.autoconfigure.web.WebProperties springWebProperties, org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties springWebFluxProperties, SwaggerIndexTransformer swaggerIndexTransformer, SwaggerResourceResolver swaggerResourceResolver, SwaggerWelcomeCommon swaggerWelcomeCommon)
      Instantiates a new Swagger web flux configurer.
      Parameters:
      swaggerUiConfigProperties - the swagger ui calculated config
      springWebProperties - the spring web config
      springWebFluxProperties - the spring webflux config
      swaggerIndexTransformer - the swagger index transformer
      swaggerResourceResolver - the swagger resource resolver
      swaggerWelcomeCommon - the swagger welcome common

  • Method Details

    • addResourceHandlers

      public void addResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry registry)
      Specified by:
      addResourceHandlers in interface org.springframework.web.reactive.config.WebFluxConfigurer

    • addSwaggerResourceHandlers

      protected void addSwaggerResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry registry, org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig... handlerConfigs)
      Add resource handlers that use the Swagger resource resolver and transformer.
      Parameters:
      registry - the resource handler registry.
      handlerConfigs - the swagger handler configs.

    • addSwaggerResourceHandler

      protected void addSwaggerResourceHandler(org.springframework.web.reactive.config.ResourceHandlerRegistry registry, org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig handlerConfig)
      Add a resource handler that uses the Swagger resource resolver and transformer.
      Parameters:
      registry - the resource handler registry.
      handlerConfig - the swagger handler config.

    • getUiRootPath

      protected String getUiRootPath()
      Specified by:
      getUiRootPath in class org.springdoc.ui.AbstractSwaggerConfigurer

    • getWebjarsPathPattern

      protected String getWebjarsPathPattern()
      Specified by:
      getWebjarsPathPattern in class org.springdoc.ui.AbstractSwaggerConfigurer

    • getCache

      protected org.springframework.cache.Cache getCache()
      Gets the Swagger resource chain cache.
      Returns:
      the cache.