springfox.documentation.spi.service

Interface ResourceGroupingStrategy

All Superinterfaces:

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

Deprecated.

@since 2.2.0 - only here for backward compatibility

@Deprecated
public interface ResourceGroupingStrategy
extends org.springframework.plugin.core.Plugin<DocumentationType>

Deprecated in lieu of using ApiListingBuilderPlugins instead

Method Summary

Modifier and Type	Method and Description
java.lang.String	getResourceDescription(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Deprecated. @since 2.0.2
java.util.Set<springfox.documentation.service.ResourceGroup>	getResourceGroups(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Deprecated. Gets the resource group for a particular request mapping.
java.lang.Integer	getResourcePosition(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod) Deprecated. @since 2.0.2

Methods inherited from interface org.springframework.plugin.core.Plugin

supports

Method Detail

getResourceGroups

java.util.Set<springfox.documentation.service.ResourceGroup> getResourceGroups(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo,
                                                                               org.springframework.web.method.HandlerMethod handlerMethod)

Deprecated.

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

Parameters:

requestMappingInfo - request mapping info

handlerMethod - handler method

Returns:

Resource group uris.

See Also:

ApiListingReferenceScanner

getResourceDescription

@Deprecated
java.lang.String getResourceDescription(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo,
                                                    org.springframework.web.method.HandlerMethod handlerMethod)

Deprecated. @since 2.0.2

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

Parameters:

requestMappingInfo - request mapping info

handlerMethod - handler method

Returns:

description of the resource

getResourcePosition

@Deprecated
java.lang.Integer getResourcePosition(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo,
                                                  org.springframework.web.method.HandlerMethod handlerMethod)

Deprecated. @since 2.0.2

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

Parameters:

requestMappingInfo - mapping information

handlerMethod - handler method

Returns:

The numeric position