springfox.documentation.spring.web.paths

Class RelativePathProvider

java.lang.Object

springfox.documentation.spring.web.paths.AbstractPathProvider

springfox.documentation.spring.web.paths.RelativePathProvider

All Implemented Interfaces:

springfox.documentation.PathProvider

public class RelativePathProvider
extends AbstractPathProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT

Constructor Summary

Constructors

Constructor and Description
RelativePathProvider(javax.servlet.ServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	applicationPath() For relative PathProviders this is typically '/' meaning relative to the swagger ui page serving the documentation.
protected java.lang.String	getDocumentationPath() The base path to the swagger api documentation.

Methods inherited from class springfox.documentation.spring.web.paths.AbstractPathProvider

getApplicationBasePath, getOperationPath, getResourceListingPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT

public static final java.lang.String ROOT

See Also:

Constant Field Values

Constructor Detail

RelativePathProvider

public RelativePathProvider(javax.servlet.ServletContext servletContext)

Method Detail

applicationPath

protected java.lang.String applicationPath()

Description copied from class: AbstractPathProvider

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)

Specified by:

applicationPath in class AbstractPathProvider

Returns:

the applications base uri

getDocumentationPath

protected java.lang.String getDocumentationPath()

Description copied from class: AbstractPathProvider

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"

Specified by:

getDocumentationPath in class AbstractPathProvider

Returns:

the documentation base path