org.springdoc.webflux.ui

Class SwaggerWelcomeActuator

java.lang.Object

org.springdoc.ui.AbstractSwaggerWelcome

org.springdoc.webflux.ui.SwaggerWelcomeCommon

org.springdoc.webflux.ui.SwaggerWelcomeActuator

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

The type Swagger actuator welcome.

Author:

bnasslashen

Field Summary

Fields inherited from class org.springdoc.webflux.ui.SwaggerWelcomeCommon

webJarsPrefixUrl

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, org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties managementServerProperties) 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	calculateOauth2RedirectUrl(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
protected void	calculateUiRootPath(StringBuilder... sbUrls)
Map<String,Object>	getSwaggerUiConfig(org.springframework.http.server.reactive.ServerHttpRequest request) Gets swagger ui config.
reactor.core.publisher.Mono<Void>	redirectToUi(org.springframework.http.server.reactive.ServerHttpRequest request, org.springframework.http.server.reactive.ServerHttpResponse response) Redirect to ui mono.

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,
                              org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties managementServerProperties)

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

managementServerProperties - the management server properties

Method Detail

redirectToUi

@GetMapping(value="/")
public reactor.core.publisher.Mono<Void> redirectToUi(org.springframework.http.server.reactive.ServerHttpRequest request,
                                                                             org.springframework.http.server.reactive.ServerHttpResponse response)

Redirect to ui mono.

Overrides:

redirectToUi in class SwaggerWelcomeCommon

Parameters:

request - the request

response - the response

Returns:

the mono

getSwaggerUiConfig

@GetMapping(value="/swagger-config",
            produces="application/json")
 @ResponseBody
public Map<String,Object> getSwaggerUiConfig(org.springframework.http.server.reactive.ServerHttpRequest request)

Gets swagger ui config.

Overrides:

getSwaggerUiConfig in class SwaggerWelcomeCommon

Parameters:

request - the request

Returns:

the swagger ui config

calculateUiRootPath

protected void calculateUiRootPath(StringBuilder... sbUrls)

Specified by:

calculateUiRootPath in class org.springdoc.ui.AbstractSwaggerWelcome

calculateOauth2RedirectUrl

protected void calculateOauth2RedirectUrl(org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)

Specified by:

calculateOauth2RedirectUrl 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