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

apiDocsUrl, contextPath, springDocConfigProperties, swaggerConfigUrl, swaggerUiConfig, swaggerUiConfigParameters

Constructor Summary

Constructors

Constructor and Description
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.

Method Summary

Modifier and Type	Method and Description
protected String	buildApiDocUrl() Build api doc url string.
protected String	buildSwaggerConfigUrl() Build swagger config url string.
protected String	buildUrl(String contextPath, String docsUrl) Build url string.
protected String	buildUrlWithContextPath(String swaggerUiUrl)
protected void	calculateUiRootPath(StringBuilder... sbUrls) Calculate ui root path.
org.springframework.http.ResponseEntity<Void>	redirectToUi(javax.servlet.http.HttpServletRequest request) Redirect to ui string.

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 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(value="${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