SwaggerUIOptions

Value parameters

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.

initializerOptions

Optional Map[String,String], which allows the addition of custom options to the SwaggerUIBundle({...}) call in swagger-initializer.js. E.g. Map("oauth2RedirectUrl"->"\"http://localhost/customCallback\"") injects the key value pair oauth2RedirectUrl: "http://localhost/customCallback" into the SwaggerUIBundle({...}) call in that swagger-initializer.js file.

oAuthInitOptions

Optional Map[String,String], which allows the injection of window.ui.initOAuth({...}); with specified options as for initializerOptions. The main difference being that SwaggerUIBundle({...}) will always be called, whereas window.ui.initOAuth({...}); is called if and only if oAuthInitOptions is not None.

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).

showExtensions

Should display the content of vendor extensions (x-) fields and values for Operations, Parameters, Responses, and Schema. Defaults to false.

useRelativePaths

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

yamlName

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

Attributes

See also

Swagger UI configuration

Swagger UI OAuth2.0 configuration

Companion

object

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all