Package org.springdoc.webflux.ui

Class SwaggerWelcomeWebFlux

java.lang.Object
org.springdoc.ui.AbstractSwaggerWelcome
org.springdoc.webflux.ui.SwaggerWelcomeCommon
org.springdoc.webflux.ui.SwaggerWelcomeWebFlux
@Controller public class SwaggerWelcomeWebFlux extends SwaggerWelcomeCommon
The type Swagger welcome.
Author:
bnasslahsen

  • Field Summary

    Fields inherited from class org.springdoc.webflux.ui.SwaggerWelcomeCommon

    webJarsPrefixUrl

    Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    springDocConfigProperties, swaggerUiConfig

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerWelcomeWebFlux(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringWebProvider springWebProvider)
    Instantiates a new Swagger welcome web flux.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    buildApiDocUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
     
    protected void
    buildSwaggerConfigUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
     
    protected String
    buildUrlWithContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl)
     
    protected void
    calculateOauth2RedirectUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
     
    protected void
    calculateUiRootPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, StringBuilder... sbUrls)
     
    reactor.core.publisher.Mono<Void>
    redirectToUi(org.springframework.http.server.reactive.ServerHttpRequest request, org.springframework.http.server.reactive.ServerHttpResponse response)
    Redirect to ui mono.

    Methods inherited from class org.springdoc.webflux.ui.SwaggerWelcomeCommon

    getSwaggerUiConfig

    Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    buildConfigUrl, buildUrl, calculateUiRootCommon, getOauth2RedirectUrl, getSwaggerUiUrl, getUriComponentsBuilder, init

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SwaggerWelcomeWebFlux

      public SwaggerWelcomeWebFlux(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringWebProvider springWebProvider)
      Instantiates a new Swagger welcome web flux.
      Parameters:
      swaggerUiConfig - the swagger ui config
      springDocConfigProperties - the spring doc config properties
      springWebProvider - the spring web provider

  • Method Details

    • redirectToUi

      @GetMapping("${springdoc.swagger-ui.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_SWAGGER_UI_PATH}}") public reactor.core.publisher.Mono<Void> redirectToUi(org.springframework.http.server.reactive.ServerHttpRequest request, org.springframework.http.server.reactive.ServerHttpResponse response)
      Redirect to ui mono.
      Overrides:
      redirectToUi in class SwaggerWelcomeCommon
      Parameters:
      request - the request
      response - the response
      Returns:
      the mono

    • calculateUiRootPath

      protected void calculateUiRootPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, StringBuilder... sbUrls)
      Specified by:
      calculateUiRootPath in class org.springdoc.ui.AbstractSwaggerWelcome

    • calculateOauth2RedirectUrl

      protected void calculateOauth2RedirectUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
      Specified by:
      calculateOauth2RedirectUrl in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildApiDocUrl

      protected void buildApiDocUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
      Specified by:
      buildApiDocUrl in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildUrlWithContextPath

      protected String buildUrlWithContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl)
      Specified by:
      buildUrlWithContextPath in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildSwaggerConfigUrl

      protected void buildSwaggerConfigUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
      Specified by:
      buildSwaggerConfigUrl in class org.springdoc.ui.AbstractSwaggerWelcome