Package org.springdoc.webmvc.ui

Class SwaggerController

java.lang.Object

org.springdoc.ui.AbstractSwaggerWelcome

org.springdoc.webmvc.ui.SwaggerWelcomeCommon

org.springdoc.webmvc.ui.SwaggerWelcomeWebMvc

org.springdoc.webmvc.ui.SwaggerController

@Configuration
public class SwaggerController
extends org.springdoc.webmvc.ui.SwaggerWelcomeWebMvc

Overwrites the SwaggerController path to consider the url mapping of a DispatcherServlet, instead of always using the same URL.

See Also:

• https://github.com/springdoc/springdoc-openapi/issues/2164

Field Summary

Fields inherited from class org.springdoc.ui.AbstractSwaggerWelcome

springDocConfigProperties, swaggerUiConfig

Constructor Summary

Constructors

Constructor	Description
SwaggerController(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springframework.beans.factory.ObjectProvider<org.springdoc.core.providers.SpringWebProvider> springWebProvider)

Method Summary

Modifier and Type	Method	Description
protected void	buildFromCurrentContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters, jakarta.servlet.http.HttpServletRequest request)

Methods inherited from class org.springdoc.webmvc.ui.SwaggerWelcomeWebMvc

buildApiDocUrl, buildSwaggerConfigUrl, buildUrlWithContextPath, calculateUiRootPath, redirectToUi

Methods inherited from class org.springdoc.webmvc.ui.SwaggerWelcomeCommon

calculateOauth2RedirectUrl, openapiJson

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 Details

SwaggerController

public SwaggerController(org.springdoc.core.properties.SwaggerUiConfigProperties swaggerUiConfig,
 org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties,
 org.springframework.beans.factory.ObjectProvider<org.springdoc.core.providers.SpringWebProvider> springWebProvider)

Method Details

buildFromCurrentContextPath

protected void buildFromCurrentContextPath(org.springdoc.core.properties.SwaggerUiConfigParameters swaggerUiConfigParameters,
 jakarta.servlet.http.HttpServletRequest request)

Overrides:

buildFromCurrentContextPath in class org.springdoc.webmvc.ui.SwaggerWelcomeCommon