abstract class SwaggerSupport[F[_]] extends SwaggerSyntax[F]

Linear Supertypes
SwaggerSyntax[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerSupport
  2. SwaggerSyntax
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SwaggerSupport()(implicit F: Sync[F], etag: scala.reflect.api.JavaUniverse.WeakTypeTag[F[_]])

Type Members

  1. implicit class ListOps extends AnyRef

    Add support for adding tags before a route using the @@ operator

    Add support for adding tags before a route using the @@ operator

    Definition Classes
    SwaggerSyntax
  2. implicit class StrOps extends AnyRef

    Add support for adding documentation to routes using symbolic operators.

    Add support for adding documentation to routes using symbolic operators.

    Definition Classes
    SwaggerSyntax

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def createRhoMiddleware(swaggerFormats: SwaggerFormats = DefaultSwaggerFormats, jsonApiPath: TypedPath[F, HNil] = TypedPath(PathMatch("swagger.json")), yamlApiPath: TypedPath[F, HNil] = TypedPath(PathMatch("swagger.yaml")), swaggerRoutesInSwagger: Boolean = false, swaggerMetadata: SwaggerMetadata = SwaggerMetadata(), showType: ShowType = DefaultShowType): RhoMiddleware[F]

    Create a RhoMiddleware adding a route to get the Swagger JSON/YAML files representing the full API

  7. def createSwagger(swaggerFormats: SwaggerFormats = DefaultSwaggerFormats, swaggerMetadata: SwaggerMetadata = SwaggerMetadata(), showType: ShowType = DefaultShowType)(routes: Seq[RhoRoute[F, _]]): Swagger

    Create the swagger model for a set of routes.

  8. def createSwaggerRoute(swagger: => Swagger, jsonApiPath: TypedPath[F, HNil] = TypedPath(PathMatch("swagger.json")), yamlApiPath: TypedPath[F, HNil] = TypedPath(PathMatch("swagger.yaml"))): RhoRoutes[F]

    Create a RhoRoutes with the route to the Swagger json for the given Swagger Specification.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from SwaggerSyntax[F]

Inherited from AnyRef

Inherited from Any

Ungrouped