SwaggerUI

object SwaggerUI
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[F[_]](yaml: String, prefix: List[String], yamlName: String): List[ServerEndpoint[Any, F]]

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
prefix

The path prefix from which the documentation will be served, as a list of path segments. Defaults to List(docs), so the address of the docs will be /docs.

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.