程序包 springfox.documentation.spring.web.paths

类 AbstractPathProvider

java.lang.Object
springfox.documentation.spring.web.paths.AbstractPathProvider
所有已实现的接口:
springfox.documentation.PathProvider
直接已知子类:
RelativePathProvider
public abstract class AbstractPathProvider extends Object implements springfox.documentation.PathProvider

  • 构造器详细资料

    • AbstractPathProvider

      public AbstractPathProvider()

  • 方法详细资料

    • applicationPath

      protected abstract String applicationPath()
      For relative PathProviders this is typically '/' meaning relative to the swagger ui page serving the documentation. The swagger specification recommends that this should be an absolute URL. Corresponds to the base path attribute of a swagger api declaration. This is the actual base path serving the api (not the swagger documentation)
      返回:
      the applications base uri

    • getDocumentationPath

      protected abstract String getDocumentationPath()
      The base path to the swagger api documentation. Typically docs are served from <yourApp>/api-docs so a relative resourceListing path will omit the api-docs segment. E.g. Relative: "path": "/" Absolute: "path": "http://localhost:8080/api-docs"
      返回:
      the documentation base path

    • getApplicationBasePath

      public String getApplicationBasePath()
      指定者:
      getApplicationBasePath 在接口中 springfox.documentation.PathProvider

    • getOperationPath

      public String getOperationPath(String operationPath)
      The relative path to the operation, from the basePath, which this operation describes. The value SHOULD be in a relative (URL) path format. Includes the apiResourcePrefix
      指定者:
      getOperationPath 在接口中 springfox.documentation.PathProvider
      参数:
      operationPath - operation path
      返回:
      the relative path to the api operation
      另请参阅:

    • getResourceListingPath

      public String getResourceListingPath(String groupName, String apiDeclaration)
      Corresponds to the path attribute of a swagger Resource Object (within a Resource Listing). This method builds a URL based off of
      指定者:
      getResourceListingPath 在接口中 springfox.documentation.PathProvider
      参数:
      groupName - the group name for this Resource Object e.g. 'default'
      apiDeclaration - the identifier for the api declaration e.g 'business-controller'
      返回:
      the resource listing path
      另请参阅: