- 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 parameters:
- addServerWhenContextPathPresent
Should a default server entry be added to the generated OpenAPI model pointing to the context path, if a non-empty context path is specified in
swaggerUIOptions. In presence of a context path, either the endpoints need to be prefixed with the context path, or a server entry must be added, for invocations from within the Swagger UI to work properly. Defaults totrue.- customiseDocsModel
A function which can customise the OpenAPI model created by the OpenAPIDocsInterpreter for the given endpoints, allowing adding e.g. server information.
- openAPIInterpreterOptions
The options passed to the OpenAPIDocsInterpreter, customising the process of interpreting endpoints as OpenAPI documentation.
- swaggerUIOptions
Options passed to SwaggerUI to customise how the documentation is exposed, e.g. the path.