Package org.springdoc.webmvc.ui

Class SwaggerWelcomeCommon

java.lang.Object
org.springdoc.ui.AbstractSwaggerWelcome
org.springdoc.webmvc.ui.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.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 void
    calculateOauth2RedirectUrl(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
     
    protected Map<String,Object>
    openapiJson(jakarta.servlet.http.HttpServletRequest request)
    Openapi json map.
    protected org.springframework.http.ResponseEntity<Void>
    redirectToUi(jakarta.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

    Methods inherited from class java.lang.Object

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

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

    • openapiJson

      protected Map<String,Object> openapiJson(jakarta.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