SwaggerUIOptions

case class SwaggerUIOptions(pathPrefix: List[String], yamlName: String, contextPath: List[String])
Value parameters:
contextPath

The context path in which the documentation routes are going to be attached. Unless the endpoints are attached to /, this needs to be specified for redirects and yaml reference to work correctly. E.g. when context path is List("api", "v1"), and other parameters are left with default values, the generated full path to the yaml will be /api/v1/docs/docs.yaml. Defaults to Nil.

pathPrefix

The path prefix which will be added to the documentation endpoints, as a list of path segments. Defaults to List("docs"), so the address of the docs will be /docs (unless contextPath is non-empty).

yamlName

The name of the file, through which the yaml documentation will be served. Defaults to docs.yaml.

Companion:
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def contextPath(contextPath: List[String]): SwaggerUIOptions
def pathPrefix(pathPrefix: List[String]): SwaggerUIOptions
def yamlName(yamlName: String): SwaggerUIOptions

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product