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
    Modifier and Type
    Field
    Description
    protected org.springframework.web.util.UriComponentsBuilder
    oauthPrefix
    The Oauth prefix.
    protected String
    webJarsPrefixUrl
    The Web jars prefix url.

    Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    apiDocsUrl, contextPath, springDocConfigProperties, swaggerConfigUrl, swaggerUiConfig, swaggerUiConfigParameters

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Map<String,Object>
    getSwaggerUiConfig(org.springframework.http.server.reactive.ServerHttpRequest request)
    Gets swagger ui config.
    protected 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.ui.AbstractSwaggerWelcome

    buildApiDocUrl, buildConfigUrl, buildSwaggerConfigUrl, buildUrl, buildUrlWithContextPath, calculateOauth2RedirectUrl, calculateUiRootCommon, calculateUiRootPath, getOauth2RedirectUrl, getSwaggerUiUrl, getUriComponentsBuilder, init

    Methods inherited from class java.lang.Object

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

  • Field Details

    • webJarsPrefixUrl

      protected String webJarsPrefixUrl
      The Web jars prefix url.

    • oauthPrefix

      protected org.springframework.web.util.UriComponentsBuilder oauthPrefix
      The Oauth prefix.

  • Constructor Details

    • SwaggerWelcomeCommon

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

  • Method Details

    • redirectToUi

      protected reactor.core.publisher.Mono<Void> redirectToUi(org.springframework.http.server.reactive.ServerHttpRequest request, org.springframework.http.server.reactive.ServerHttpResponse response)
      Redirect to ui mono.
      Parameters:
      request - the request
      response - the response
      Returns:
      the mono

    • getSwaggerUiConfig

      protected Map<String,Object> getSwaggerUiConfig(org.springframework.http.server.reactive.ServerHttpRequest request)
      Gets swagger ui config.
      Parameters:
      request - the request
      Returns:
      the swagger ui config