springfox.documentation.spring.web

Class Paths

java.lang.Object

springfox.documentation.spring.web.Paths

public class Paths
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	firstPathSegment(java.lang.String path)
static java.lang.String	maybeChompLeadingSlash(java.lang.String path)
static java.lang.String	maybeChompTrailingSlash(java.lang.String path)
static java.lang.String	sanitiseUrl(java.lang.String candidate)
static java.lang.String	sanitizeRequestMappingPattern(java.lang.String requestMappingPattern) Gets a uri friendly path from a request mapping pattern.
static java.lang.String	splitCamelCase(java.lang.String s, java.lang.String separator)

Methods inherited from class java.lang.Object

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

Method Detail

splitCamelCase

public static java.lang.String splitCamelCase(java.lang.String s,
                              java.lang.String separator)

maybeChompLeadingSlash

public static java.lang.String maybeChompLeadingSlash(java.lang.String path)

maybeChompTrailingSlash

public static java.lang.String maybeChompTrailingSlash(java.lang.String path)

firstPathSegment

public static java.lang.String firstPathSegment(java.lang.String path)

sanitizeRequestMappingPattern

public static java.lang.String sanitizeRequestMappingPattern(java.lang.String requestMappingPattern)

Gets a uri friendly path from a request mapping pattern. Typically involves removing any regex patterns or || conditions from a spring request mapping This method will be called to resolve every request mapping endpoint. A good extension point if you need to alter endpoints by adding or removing path segments. Note: this should not be an absolute uri

Parameters:

requestMappingPattern -

Returns:

the request mapping endpoint

sanitiseUrl

public static java.lang.String sanitiseUrl(java.lang.String candidate)