org.apache.geode.rest.internal.web.swagger.config

Class SwaggerConfig

java.lang.Object

org.apache.geode.rest.internal.web.swagger.config.SwaggerConfig

@Configuration
 @ComponentScan(basePackages="com.mangofactory.swagger")
public class SwaggerConfig
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	DEFAULT_INCLUDE_PATTERNS
protected static java.lang.String	SWAGGER_GROUP

Constructor Summary

Constructors

Constructor and Description
SwaggerConfig()

Method Summary

Modifier and Type	Method and Description
com.mangofactory.swagger.scanners.ApiListingReferenceScanner	apiListingReferenceScanner() The ApiListingReferenceScanner does most of the work.
RestApiPathProvider	apiPathProvider() Example of a custom path provider
com.mangofactory.swagger.configuration.JacksonScalaSupport	jacksonScalaSupport() Adds the Jackson Scala module to the MappingJackson2HttpMessageConverter registered with Spring.
com.mangofactory.swagger.core.SwaggerApiResourceListing	swaggerApiResourceListing() Configure a SwaggerApiResourceListing for each Swagger instance within your app.
com.mangofactory.swagger.configuration.SwaggerGlobalSettings	swaggerGlobalSettings() Global Swagger configuration settings

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INCLUDE_PATTERNS

protected static final java.util.List<java.lang.String> DEFAULT_INCLUDE_PATTERNS

SWAGGER_GROUP

protected static final java.lang.String SWAGGER_GROUP

See Also:

Constant Field Values

Constructor Detail

SwaggerConfig

public SwaggerConfig()

Method Detail

jacksonScalaSupport

@Bean
public com.mangofactory.swagger.configuration.JacksonScalaSupport jacksonScalaSupport()

Adds the Jackson Scala module to the MappingJackson2HttpMessageConverter registered with Spring. Swagger core models are Scala so we need to be able to convert to JSON. Also registers some custom serializers needed to transform Swagger models to Swagger-UI required JSON format.

swaggerApiResourceListing

@Bean
public com.mangofactory.swagger.core.SwaggerApiResourceListing swaggerApiResourceListing()

Configure a SwaggerApiResourceListing for each Swagger instance within your app. e.g. 1. private 2. external APIs 3. ..., required to be a Spring bean as Spring will call the postConstruct method to bootstrap Swagger scanning.

swaggerGlobalSettings

@Bean
public com.mangofactory.swagger.configuration.SwaggerGlobalSettings swaggerGlobalSettings()

Global Swagger configuration settings

apiListingReferenceScanner

@Bean
public com.mangofactory.swagger.scanners.ApiListingReferenceScanner apiListingReferenceScanner()

The ApiListingReferenceScanner does most of the work. It scans the appropriate Spring RequestMappingHandlerMappings, applies the correct absolute paths to the generated Swagger resources, and so on.

apiPathProvider

@Bean
public RestApiPathProvider apiPathProvider()

Example of a custom path provider