Instance Constructors

1.  new RedocUIOptions(pathPrefix: List[String], specName: String, htmlName: String, contextPath: List[String], useRelativePaths: Boolean, redocVersion: String, redocOptions: Option[String], redocThemeOptionsJson: Option[String])
   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).

   specName

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

   htmlName

   the name of the file, through which the html documentation will be served. Defaults to index.html.

   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.

   redocVersion

   Version of Redoc library

   redocOptions

   Options to pass to the Redoc library (see https://redocly.com/docs/api-reference-docs/configuration/functionality/)

   redocThemeOptionsJson

   Theming options to pass to the Redoc library (see https://redocly.com/docs/api-reference-docs/configuration/theming/). Must be a valid JSON if not empty