Packages

object SwaggerInterpreter

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerInterpreter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(openAPIInterpreterOptions: OpenAPIDocsOptions = OpenAPIDocsOptions.default, customiseDocsModel: (OpenAPI) ⇒ OpenAPI = identity, swaggerUIOptions: SwaggerUIOptions = SwaggerUIOptions.default, addServerWhenContextPathPresent: Boolean = true): SwaggerInterpreter

    Allows interpreting lists of sttp.tapir.Endpoints or ServerEndpoints as Swagger UI 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.

    openAPIInterpreterOptions

    The options passed to the OpenAPIDocsInterpreter, customising the process of interpreting endpoints as OpenAPI documentation.

    customiseDocsModel

    A function which can customise the OpenAPI model created by the OpenAPIDocsInterpreter for the given endpoints, allowing adding e.g. server information.

    swaggerUIOptions

    Options passed to SwaggerUI to customise how the documentation is exposed, e.g. the path.

    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 to true.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped