springfox.documentation.spring.web.scanners

Class ApiListingReader

java.lang.Object

springfox.documentation.spring.web.scanners.ApiListingReader

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<DocumentationType>, ApiListingBuilderPlugin

@Component
 @Order(value=-2147483648)
public class ApiListingReader
extends java.lang.Object
implements ApiListingBuilderPlugin

Constructor Summary

Constructors

Constructor and Description
ApiListingReader()

Method Summary

Modifier and Type	Method and Description
void	apply(ApiListingContext apiListingContext) Implement this method to override the ApiListing using the ApiListingBuilder
boolean	supports(DocumentationType delimiter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiListingReader

public ApiListingReader()

Method Detail

apply

public void apply(ApiListingContext apiListingContext)

Description copied from interface: ApiListingBuilderPlugin

Implement this method to override the ApiListing using the ApiListingBuilder

Specified by:

apply in interface ApiListingBuilderPlugin

Parameters:

apiListingContext - - context that can be used to override the model property attributes

See Also:

ApiListing, ApiListingBuilder

supports

public boolean supports(DocumentationType delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<DocumentationType>