Package org.springdoc.webmvc.ui

Class SwaggerWelcomeWebMvc

  • @Controller
public class SwaggerWelcomeWebMvc
extends SwaggerWelcomeCommon
    The type Swagger welcome.
    Author:
    bnasslahsen

    • Constructor Detail

      • SwaggerWelcomeWebMvc

        public SwaggerWelcomeWebMvc​(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig,
                            org.springdoc.core.SpringDocConfigProperties springDocConfigProperties,
                            org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters,
                            org.springdoc.core.providers.SpringWebProvider springWebProvider)
        Instantiates a new Swagger welcome web mvc.
        Parameters:
        swaggerUiConfig - the swagger ui config
        springDocConfigProperties - the spring doc config properties
        swaggerUiConfigParameters - the swagger ui config parameters
        springWebProvider - the spring web provider

    • Method Detail

      • redirectToUi

        @GetMapping("${springdoc.swagger-ui.path:#{T(org.springdoc.core.Constants).DEFAULT_SWAGGER_UI_PATH}}")
public org.springframework.http.ResponseEntity<Void> redirectToUi​(javax.servlet.http.HttpServletRequest request)
        Redirect to ui string.
        Overrides:
        redirectToUi in class SwaggerWelcomeCommon
        Parameters:
        request - the request
        Returns:
        the string

      • calculateUiRootPath

        protected void calculateUiRootPath​(StringBuilder... sbUrls)
        Calculate ui root path.
        Specified by:
        calculateUiRootPath in class org.springdoc.ui.AbstractSwaggerWelcome
        Parameters:
        sbUrls - the sb urls

      • buildUrl

        protected String buildUrl​(String contextPath,
                          String docsUrl)
        Build url string.
        Overrides:
        buildUrl in class org.springdoc.ui.AbstractSwaggerWelcome
        Parameters:
        contextPath - the context path
        docsUrl - the docs url
        Returns:
        the string

      • 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