- Companion
- class
Value members
Concrete methods
Allows interpreting lists of sttp.tapir.Endpoints or ServerEndpoints as Swagger UI 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 Swagger UI 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 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 redirect to work correctly. Defaults toNil, so it is assumed that the endpoint base path is/.- docsExtensions
The top-level documentation extensions to be included in the generated OpenAPI docs.
- 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)- yamlName
The name of the file, through which the yaml documentation will be served. Defaults to
docs.yaml.