springfox.documentation.spring.web

Class SpringGroupingStrategy

java.lang.Object

springfox.documentation.spring.web.SpringGroupingStrategy

All Implemented Interfaces:

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

public class SpringGroupingStrategy
extends java.lang.Object
implements ResourceGroupingStrategy

TODO - fix or remove There are a lot of cases this strategy does not cover. - request mappings of varying path depths, - Paths beginning with path variables - Controllers without top level request mappings

Constructor Summary

Constructors

Constructor and Description
SpringGroupingStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getResourceDescription(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Gets the resource description.
java.util.Set<ResourceGroup>	getResourceGroups(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Gets the resource group for a particular request mapping.
java.lang.Integer	getResourcePosition(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Gets the position of the resource.
boolean	supports(DocumentationType delimiter)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringGroupingStrategy

public SpringGroupingStrategy()

Method Detail

getResourceGroups

public java.util.Set<ResourceGroup> getResourceGroups(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo,
                                             org.springframework.web.method.HandlerMethod handlerMethod)

Description copied from interface: ResourceGroupingStrategy

Gets the resource group for a particular request mapping. Typically several requestMappings will live under a particular resource group.

Specified by:

getResourceGroups in interface ResourceGroupingStrategy

Parameters:

requestMappingInfo - request mapping info

handlerMethod - handler method

Returns:

Resource group uris.

See Also:

ApiListingReferenceScanner

getResourceDescription

public java.lang.String getResourceDescription(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo,
                                      org.springframework.web.method.HandlerMethod handlerMethod)

Description copied from interface: ResourceGroupingStrategy

Gets the resource description. This is typically the class name of the spring controller or value() attribute of any @Api annotations on that controller class This method is deprecated since this functionality will likely be changed as we rework some of the internals

Specified by:

getResourceDescription in interface ResourceGroupingStrategy

Parameters:

requestMappingInfo - request mapping info

handlerMethod - handler method

Returns:

description of the resource

getResourcePosition

public java.lang.Integer getResourcePosition(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo,
                                    org.springframework.web.method.HandlerMethod handlerMethod)

Description copied from interface: ResourceGroupingStrategy

Gets the position of the resource. This method is deprecated since this functionality will likely be changed as we rework some of the internals

Specified by:

getResourcePosition in interface ResourceGroupingStrategy

Parameters:

requestMappingInfo - mapping information

handlerMethod - handler method

Returns:

The numeric position

supports

public boolean supports(DocumentationType delimiter)

Specified by:

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