Package org.springdoc.webmvc.ui

Class SwaggerWelcomeCommon

  • Direct Known Subclasses:
    SwaggerWelcomeActuator, SwaggerWelcomeWebMvc
    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

        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 void calculateOauth2RedirectUrl​(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)  
      protected Map<String,​Object> openapiJson​(javax.servlet.http.HttpServletRequest request)
      Openapi json map.
      protected org.springframework.http.ResponseEntity<Void> redirectToUi​(javax.servlet.http.HttpServletRequest request)
      Redirect to ui response entity.

      • Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

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

    • 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 org.springframework.http.ResponseEntity<Void> redirectToUi​(javax.servlet.http.HttpServletRequest request)
        Redirect to ui response entity.
        Parameters:
        request - the request
        Returns:
        the response entity

      • openapiJson

        protected Map<String,​Object> openapiJson​(javax.servlet.http.HttpServletRequest request)
        Openapi json map.
        Parameters:
        request - the request
        Returns:
        the map

      • calculateOauth2RedirectUrl

        protected void calculateOauth2RedirectUrl​(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
        Specified by:
        calculateOauth2RedirectUrl in class org.springdoc.ui.AbstractSwaggerWelcome