tapir-redoc-bundle/sttp.tapir.redoc.bundle/RedocInterpreter

RedocInterpreter

object RedocInterpreter
Companion:
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(docsExtensions: List[DocsExtension[_]], docsOptions: OpenAPIDocsOptions, prefix: List[String], yamlName: String, htmlName: String, redocVersion: String): RedocInterpreter

Allows interpreting lists of sttp.tapir.Endpoints or ServerEndpoints as Redoc docs. The docs will be serialised in the yaml format, and will be available using the configured prefix path, by default /docs.

Allows interpreting lists of sttp.tapir.Endpoints or ServerEndpoints as Redoc docs. The docs will be serialised in the yaml format, and will be available using the configured prefix path, by default /docs.

Usage: pass the result of SwaggerInterpreter().fromEndpoints[F] to your server interpreter.

Value parameters:
docsExtensions

The top-level documentation extensions to be included in the generated OpenAPI docs.

docsOptions

The options that will be passed to the OpenAPIDocsInterpreter.

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.

yamlName

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