springfox.documentation.spring.web

Class SpringGroupingStrategy

java.lang.Object

springfox.documentation.spring.web.SpringGroupingStrategy

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.service.ResourceGroupingStrategy

public class SpringGroupingStrategy
extends java.lang.Object
implements springfox.documentation.spi.service.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

Modifier and Type	Method and Description
java.lang.String	getResourceDescription(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod)
java.util.Set<springfox.documentation.service.ResourceGroup>	getResourceGroups(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod)
java.lang.Integer	getResourcePosition(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo, org.springframework.web.method.HandlerMethod handlerMethod)
boolean	supports(springfox.documentation.spi.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<springfox.documentation.service.ResourceGroup> getResourceGroups(springfox.documentation.spring.wrapper.RequestMappingInfo requestMappingInfo,
                                                                                      org.springframework.web.method.HandlerMethod handlerMethod)

Specified by:

getResourceGroups in interface springfox.documentation.spi.service.ResourceGroupingStrategy

getResourceDescription

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

Specified by:

getResourceDescription in interface springfox.documentation.spi.service.ResourceGroupingStrategy

getResourcePosition

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

Specified by:

getResourcePosition in interface springfox.documentation.spi.service.ResourceGroupingStrategy

supports

public boolean supports(springfox.documentation.spi.DocumentationType delimiter)

Specified by:

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