Package org.springdoc.webflux.ui

Class SwaggerWelcomeCommon

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean
    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.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters)
      Instantiates a new Abstract swagger welcome.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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

        afterPropertiesSet, buildApiDocUrl, buildConfigUrl, buildSwaggerConfigUrl, buildUrl, calculateOauth2RedirectUrl, calculateUiRootCommon, calculateUiRootPath, getOauth2RedirectUrl, getSwaggerUiUrl, getUriComponentsBuilder

    • Field Detail

      • webJarsPrefixUrl

        protected String webJarsPrefixUrl
        The Web jars prefix url.

      • oauthPrefix

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

    • Constructor Detail

      • SwaggerWelcomeCommon

        public SwaggerWelcomeCommon​(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig,
                            org.springdoc.core.SpringDocConfigProperties springDocConfigProperties,
                            org.springdoc.core.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 Detail

      • 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