Package org.springdoc.webflux.ui

Class SwaggerWelcomeCommon

java.lang.Object
org.springdoc.ui.AbstractSwaggerWelcome
org.springdoc.webflux.ui.SwaggerWelcomeCommon
Direct Known Subclasses:
SwaggerWelcomeActuator, SwaggerWelcomeWebFlux
public abstract class SwaggerWelcomeCommon extends org.springdoc.ui.AbstractSwaggerWelcome
The type Swagger welcome common.
Author:
bnasslashen

  • Field Summary

    Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    springDocConfigProperties, swaggerUiConfig

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SwaggerWelcomeCommon(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties)
    Instantiates a new Abstract swagger welcome.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    buildFromCurrentContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.web.server.ServerWebExchange exchange)
    From current context path string.
    protected void
    calculateOauth2RedirectUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
     
    protected abstract void
    calculateUiRootPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, StringBuilder... sbUrls)
     
    protected Map<String,Object>
    getSwaggerUiConfig(org.springframework.web.server.ServerWebExchange exchange)
    Gets swagger ui config.
    protected reactor.core.publisher.Mono<Void>
    redirectToUi(org.springframework.web.server.ServerWebExchange exchange)
    Redirect to ui mono.

    Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    buildApiDocUrl, buildConfigUrl, buildSwaggerConfigUrl, buildUrl, buildUrlWithContextPath, 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

    • SwaggerWelcomeCommon

      protected SwaggerWelcomeCommon(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties)
      Instantiates a new Abstract swagger welcome.
      Parameters:
      swaggerUiConfig - the swagger ui config
      springDocConfigProperties - the spring doc config properties

  • Method Details

    • redirectToUi

      protected reactor.core.publisher.Mono<Void> redirectToUi(org.springframework.web.server.ServerWebExchange exchange)
      Redirect to ui mono.
      Parameters:
      exchange - the exchange
      Returns:
      the mono

    • 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

    • calculateUiRootPath

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

    • getSwaggerUiConfig

      protected Map<String,Object> getSwaggerUiConfig(org.springframework.web.server.ServerWebExchange exchange)
      Gets swagger ui config.
      Parameters:
      exchange - the exchange
      Returns:
      the swagger ui config

    • buildFromCurrentContextPath

      protected void buildFromCurrentContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.web.server.ServerWebExchange exchange)
      From current context path string.
      Parameters:
      swaggerUiConfigParameters - the swagger ui config parameters
      exchange - the exchange