Package springfox.documentation

Interface PathProvider

  • public interface PathProvider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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

      • 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