Package org.springdoc.webmvc.ui

Class SwaggerWelcomeWebMvc

java.lang.Object
org.springdoc.ui.AbstractSwaggerWelcome
org.springdoc.webmvc.ui.SwaggerWelcomeCommon
org.springdoc.webmvc.ui.SwaggerWelcomeWebMvc
@Controller public class SwaggerWelcomeWebMvc extends SwaggerWelcomeCommon
The type Swagger welcome.
Author:
bnasslahsen

  • Field Summary

    Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    springDocConfigProperties, swaggerUiConfig

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerWelcomeWebMvc(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringWebProvider springWebProvider)
    Instantiates a new Swagger welcome web mvc.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    buildApiDocUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
     
    protected void
    buildSwaggerConfigUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
     
    protected String
    buildUrl(String contextPath, String docsUrl)
     
    protected String
    buildUrlWithContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl)
     
    protected void
    calculateUiRootPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, StringBuilder... sbUrls)
     
    org.springframework.http.ResponseEntity<Void>
    redirectToUi(jakarta.servlet.http.HttpServletRequest request)
    Redirect to ui response entity.

    Methods inherited from class org.springdoc.webmvc.ui.SwaggerWelcomeCommon

    calculateOauth2RedirectUrl, openapiJson

    Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

    buildConfigUrl, 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

    • SwaggerWelcomeWebMvc

      public SwaggerWelcomeWebMvc(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, 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
      springWebProvider - the spring web provider

  • Method Details

    • redirectToUi

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

    • calculateUiRootPath

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

    • buildUrl

      protected String buildUrl(String contextPath, String docsUrl)
      Overrides:
      buildUrl in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildApiDocUrl

      protected void buildApiDocUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
      Specified by:
      buildApiDocUrl in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildUrlWithContextPath

      protected String buildUrlWithContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, String swaggerUiUrl)
      Specified by:
      buildUrlWithContextPath in class org.springdoc.ui.AbstractSwaggerWelcome

    • buildSwaggerConfigUrl

      protected void buildSwaggerConfigUrl(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters)
      Specified by:
      buildSwaggerConfigUrl in class org.springdoc.ui.AbstractSwaggerWelcome