springfox.documentation

Interface PathProvider

All Known Implementing Classes:

AbstractPathProvider, RelativePathProvider

public interface PathProvider

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationBasePath() Gets the application base path
java.lang.String	getOperationPath(java.lang.String operationPath) Gets the sanitized and prepended with a "/" operation path
java.lang.String	getResourceListingPath(java.lang.String groupName, java.lang.String apiDeclaration) Gets the resource listing path given a group name and api

Method Detail

getApplicationBasePath

java.lang.String getApplicationBasePath()

Gets the application base path

Returns:

application base path

getOperationPath

java.lang.String getOperationPath(java.lang.String operationPath)

Gets the sanitized and prepended with a "/" operation path

Parameters:

operationPath - - raw operation path

Returns:

sanitized and prepended with a "/" operation path

getResourceListingPath

java.lang.String getResourceListingPath(java.lang.String groupName,
                                        java.lang.String apiDeclaration)

Gets the resource listing path given a group name and api

Parameters:

groupName - - group this resource listing belongs to

apiDeclaration - - declared api name

Returns:

this