Packages

case class SwaggerUIOptions(pathPrefix: List[String], yamlName: String, contextPath: List[String], useRelativePaths: Boolean) extends Product with Serializable

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 (relative to the context in which the interpreted docs endpoints are attached).

yamlName

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

contextPath

The context path in which the interpreted documentation endpoints are going to be attached. Only relevant when {{useRelativePaths == false}}. E.g. when context path is List("api", "v1"), useRelativePaths = false, and other parameters are left with default values, the generated full path to the yaml will be /api/v1/docs/docs.yaml, instead of ./docs/docs.yaml or ./docs.yaml (depending on the referrer's uri). Also used for creating redirects. Defaults to Nil.

useRelativePaths

Should relative paths be used for yaml references and redirects. Defaults to true.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerUIOptions
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SwaggerUIOptions(pathPrefix: List[String], yamlName: String, contextPath: List[String], useRelativePaths: Boolean)

    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 (relative to the context in which the interpreted docs endpoints are attached).

    yamlName

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

    contextPath

    The context path in which the interpreted documentation endpoints are going to be attached. Only relevant when {{useRelativePaths == false}}. E.g. when context path is List("api", "v1"), useRelativePaths = false, and other parameters are left with default values, the generated full path to the yaml will be /api/v1/docs/docs.yaml, instead of ./docs/docs.yaml or ./docs.yaml (depending on the referrer's uri). Also used for creating redirects. Defaults to Nil.

    useRelativePaths

    Should relative paths be used for yaml references and redirects. Defaults to true.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def contextPath(contextPath: List[String]): SwaggerUIOptions
  7. val contextPath: List[String]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def pathPrefix(pathPrefix: List[String]): SwaggerUIOptions
  15. val pathPrefix: List[String]
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. val useRelativePaths: Boolean
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. def withAbsolutePaths: SwaggerUIOptions
  23. def withRelativePaths: SwaggerUIOptions
  24. def yamlName(yamlName: String): SwaggerUIOptions
  25. val yamlName: String

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped