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.ui.AbstractSwaggerWelcome

    springDocConfigProperties, swaggerUiConfig

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    buildUrlWithContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl)
     
    reactor.core.publisher.Mono<Void>
    redirectToUi(org.springframework.web.server.ServerWebExchange exchange)
    Redirect to ui mono.

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

    buildFromCurrentContextPath, calculateOauth2RedirectUrl, calculateUiRootPath, getSwaggerUiConfig

    Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    buildApiDocUrl, buildConfigUrl, buildSwaggerConfigUrl, 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.springframework.beans.factory.ObjectProvider<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.web.server.ServerWebExchange exchange)
      Redirect to ui mono.
      Overrides:
      redirectToUi in class SwaggerWelcomeCommon
      Parameters:
      exchange - the exchange
      Returns:
      the mono

    • buildUrlWithContextPath

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