org.springdoc.webmvc.ui

Class SwaggerWelcomeWebMvc

java.lang.Object

org.springdoc.ui.AbstractSwaggerWelcome

org.springdoc.webmvc.ui.SwaggerWelcomeCommon

org.springdoc.webmvc.ui.SwaggerWelcomeWebMvc

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Controller
public class SwaggerWelcomeWebMvc
extends SwaggerWelcomeCommon

The type Swagger welcome.

Author:

bnasslahsen

Field Summary

Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

apiDocsUrl, 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) Instantiates a new Swagger welcome.

Method Summary

Modifier and Type	Method and Description
protected String	buildApiDocUrl(String contextPath)
protected String	buildSwaggerConfigUrl(String contextPath)
protected String	buildUrl(String contextPath, String docsUrl)
protected void	calculateUiRootPath(StringBuilder... sbUrls)
Map<String,Object>	openapiJson(javax.servlet.http.HttpServletRequest request) Openapi yaml map.
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

Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

afterPropertiesSet, buildConfigUrl, calculateUiRootCommon, getOauth2RedirectUrl, getUriComponentsBuilder

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)

Instantiates a new Swagger welcome.

Parameters:

swaggerUiConfig - the swagger ui config

springDocConfigProperties - the spring doc config properties

swaggerUiConfigParameters - the swagger ui config parameters

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

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}/swagger-config",
            produces="application/json")
 @ResponseBody
public Map<String,Object> openapiJson(javax.servlet.http.HttpServletRequest request)

Openapi yaml map.

Overrides:

openapiJson in class SwaggerWelcomeCommon

Parameters:

request - the request

Returns:

the map

calculateUiRootPath

protected void calculateUiRootPath(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 String buildApiDocUrl(String contextPath)

Overrides:

buildApiDocUrl in class org.springdoc.ui.AbstractSwaggerWelcome

buildSwaggerConfigUrl

protected String buildSwaggerConfigUrl(String contextPath)

Overrides:

buildSwaggerConfigUrl in class org.springdoc.ui.AbstractSwaggerWelcome