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

    oauthPrefix, webJarsPrefixUrl

    Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    apiDocsUrl, contextPath, springDocConfigProperties, swaggerConfigUrl, swaggerUiConfig, swaggerUiConfigParameters

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    buildApiDocUrl()
    Build api doc url string.
    protected String
    buildSwaggerConfigUrl()
    Build swagger config url string.
    protected String
    buildUrlWithContextPath(String swaggerUiUrl)
     
    protected void
    calculateOauth2RedirectUrl(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
    Calculate oauth 2 redirect url.
    protected void
    calculateUiRootPath(StringBuilder... sbUrls)
    Calculate ui root path.
    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.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, 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
      swaggerUiConfigParameters - the swagger ui config parameters
      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(StringBuilder... sbUrls)
      Calculate ui root path.
      Specified by:
      calculateUiRootPath in class org.springdoc.ui.AbstractSwaggerWelcome
      Parameters:
      sbUrls - the sb urls

    • calculateOauth2RedirectUrl

      protected void calculateOauth2RedirectUrl(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
      Calculate oauth 2 redirect url.
      Specified by:
      calculateOauth2RedirectUrl in class org.springdoc.ui.AbstractSwaggerWelcome
      Parameters:
      uriComponentsBuilder - the uri components builder

    • buildApiDocUrl

      protected String buildApiDocUrl()
      Build api doc url string.
      Specified by:
      buildApiDocUrl in class org.springdoc.ui.AbstractSwaggerWelcome
      Returns:
      the string

    • buildUrlWithContextPath

      protected String buildUrlWithContextPath(String swaggerUiUrl)
      Specified by:
      buildUrlWithContextPath in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildSwaggerConfigUrl

      protected String buildSwaggerConfigUrl()
      Build swagger config url string.
      Specified by:
      buildSwaggerConfigUrl in class org.springdoc.ui.AbstractSwaggerWelcome
      Returns:
      the string