org.springdoc.ui

Class SwaggerWelcome

java.lang.Object

org.springdoc.ui.AbstractSwaggerWelcome

org.springdoc.ui.SwaggerWelcome

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Controller
 @ConditionalOnProperty(name="springdoc.swagger-ui.enabled",
                       matchIfMissing=true)
 @ConditionalOnBean(value=org.springdoc.core.SpringDocConfiguration.class)
public class SwaggerWelcome
extends org.springdoc.ui.AbstractSwaggerWelcome

Field Summary

Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

oauth2RedirectUrl, springDocConfigProperties, swaggerUiConfig, uiRootPath

Constructor Summary

Constructors

Constructor and Description
SwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties)

Method Summary

Modifier and Type	Method and Description
protected String	buildUrl(String contextPath, String docsUrl)
Map<String,Object>	openapiYaml(javax.servlet.http.HttpServletRequest request)
String	redirectToUi(javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.springdoc.ui.AbstractSwaggerWelcome

afterPropertiesSet, buildConfigUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerWelcome

public SwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig,
                      SpringDocConfigProperties springDocConfigProperties)

Method Detail

redirectToUi

@GetMapping(value="${springdoc.swagger-ui.path:#{T(org.springdoc.core.Constants).DEFAULT_SWAGGER_UI_PATH}}")
public String redirectToUi(javax.servlet.http.HttpServletRequest request)

openapiYaml

@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> openapiYaml(javax.servlet.http.HttpServletRequest request)

buildUrl

protected String buildUrl(String contextPath,
                          String docsUrl)

Overrides:

buildUrl in class org.springdoc.ui.AbstractSwaggerWelcome