org.springframework.cloud.dataflow.server.config

Class SpringDocAutoConfiguration

java.lang.Object

org.springframework.cloud.dataflow.server.config.SpringDocAutoConfiguration

@Configuration(proxyBeanMethods=false)
 @ConditionalOnClass(value={org.springdoc.core.SpringDocConfigProperties.class,org.springdoc.core.SwaggerUiConfigProperties.class})
 @ConditionalOnBean(value={org.springdoc.core.SpringDocConfigProperties.class,org.springdoc.core.SwaggerUiConfigProperties.class})
 @AutoConfigureAfter(value={org.springdoc.core.SpringDocConfiguration.class,org.springdoc.webmvc.ui.SwaggerConfig.class})
public class SpringDocAutoConfiguration
extends Object

Makes SpringDoc public available without any authentication required by initializing a WebSecurityCustomizer and applying all path of SpringDoc to be ignored. Also applies a filter registration bean to unescape JSON content for the SpringDoc frontend.

Author:

Tobias Soloschenko

Constructor Summary

Constructors

Constructor and Description
SpringDocAutoConfiguration(org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfigProperties) Creates the SpringDocConfiguration with the given properties.

Method Summary

Modifier and Type	Method and Description
org.springframework.boot.web.servlet.FilterRegistrationBean<SpringDocJsonDecodeFilter>	springDocJsonDecodeFilterRegistration() Applies SpringDocJsonDecodeFilter to the filter chain which decodes the JSON of ApiDocs and SwaggerUi so that the SpringDoc frontend is able to read it.
org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer	springDocWebSecurityCustomizer() Creates a web security customizer for the spring security which makes the SpringDoc frontend public available.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringDocAutoConfiguration

public SpringDocAutoConfiguration(org.springdoc.core.SpringDocConfigProperties springDocConfigProperties,
                                  org.springdoc.core.SwaggerUiConfigProperties swaggerUiConfigProperties)

Creates the SpringDocConfiguration with the given properties.

Parameters:

springDocConfigProperties - the spring doc config properties

swaggerUiConfigProperties - the swagger ui config properties

Method Detail

springDocWebSecurityCustomizer

@Bean
 @ConditionalOnMissingBean
public org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer springDocWebSecurityCustomizer()

Creates a web security customizer for the spring security which makes the SpringDoc frontend public available.

Returns:

a web security customizer with security settings for SpringDoc

springDocJsonDecodeFilterRegistration

@Bean
 @ConditionalOnMissingBean(name="springDocJsonDecodeFilterRegistration")
public org.springframework.boot.web.servlet.FilterRegistrationBean<SpringDocJsonDecodeFilter> springDocJsonDecodeFilterRegistration()

Applies SpringDocJsonDecodeFilter to the filter chain which decodes the JSON of ApiDocs and SwaggerUi so that the SpringDoc frontend is able to read it. Spring Cloud Data Flow however requires the JSON to be escaped and wrapped into quotes, because the Angular Ui frontend is using it that way.

Returns:

a filter registration bean which unescapes the content of the JSON endpoints of SpringDoc before it is returned.