SwaggerUI
Value members
Concrete methods
Usage: pass SwaggerUI[F](yaml) endpoints to your server interpreter. Docs will be available using the /docs path.
Usage: pass SwaggerUI[F](yaml) endpoints to your server interpreter. Docs will be available using the /docs path.
- Value Params
- basePrefix
The base path prefix where the documentation routes are going to be attached. Unless the endpoint will served from
/, the base path prefix must be specified for redirects and yaml reference to work correctly. Defaults toNil, so it is assumed that the endpoint base path is/.- prefix
The path prefix for which the documentation endpoint will be created, as a list of path segments. Defaults to
List(docs), so the address of the docs will be/docs(unlessbasePrefixis specified).- yaml
The yaml with the OpenAPI documentation.
- yamlName
The name of the file, through which the yaml documentation will be served. Defaults to
docs.yaml.