org.springdoc.webmvc.ui

Class SwaggerWelcomeActuator

java.lang.Object

org.springdoc.ui.AbstractSwaggerWelcome

org.springdoc.webmvc.ui.SwaggerWelcomeCommon

org.springdoc.webmvc.ui.SwaggerWelcomeActuator

@ControllerEndpoint(id="swagger-ui")
public class SwaggerWelcomeActuator
extends SwaggerWelcomeCommon

The type Swagger actuator welcome.

Field Summary

Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

apiDocsUrl, contextPath, springDocConfigProperties, swaggerConfigUrl, swaggerUiConfig, swaggerUiConfigParameters

Constructor Summary

Constructors

Constructor and Description
SwaggerWelcomeActuator(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters, org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties) Instantiates a new Swagger welcome.

Method Summary

Modifier and Type	Method and Description
protected String	buildApiDocUrl()
protected String	buildSwaggerConfigUrl()
protected String	buildUrlWithContextPath(String swaggerUiUrl)
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

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

SwaggerWelcomeActuator

public SwaggerWelcomeActuator(org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfig,
                              org.springdoc.core.SpringDocConfigProperties springDocConfigProperties,
                              org.springdoc.core.SwaggerUiConfigParameters swaggerUiConfigParameters,
                              org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties)

Instantiates a new Swagger welcome.

Parameters:

swaggerUiConfig - the swagger ui config

springDocConfigProperties - the spring doc config properties

swaggerUiConfigParameters - the swagger ui config parameters

webEndpointProperties - the web endpoint properties

Method Detail

redirectToUi

@GetMapping(value="/")
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="/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

buildApiDocUrl

protected String buildApiDocUrl()

Specified by:

buildApiDocUrl in class org.springdoc.ui.AbstractSwaggerWelcome

buildUrlWithContextPath

protected String buildUrlWithContextPath(String swaggerUiUrl)

Specified by:

buildUrlWithContextPath in class org.springdoc.ui.AbstractSwaggerWelcome

buildSwaggerConfigUrl

protected String buildSwaggerConfigUrl()

Specified by:

buildSwaggerConfigUrl in class org.springdoc.ui.AbstractSwaggerWelcome