SwaggerSupport

Instance Constructors

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

Type Members

implicit class StrOps extends AnyRef

Add support for adding documentation before a route using the ** operator
Add support for adding documentation before a route using the ** operator

Definition Classes
SwaggerSyntax

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createRhoMiddleware(swaggerFormats: SwaggerFormats = DefaultSwaggerFormats, apiPath: TypedPath[F, HNil] = ..., apiInfo: Info = ..., swaggerRoutesInSwagger: Boolean = false, host: Option[String] = None, basePath: Option[String] = None, schemes: List[Scheme] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, security: List[SecurityRequirement] = Nil, securityDefinitions: Map[String, SecuritySchemeDefinition] = Map.empty, vendorExtensions: Map[String, AnyRef] = Map.empty): RhoMiddleware[F]

Create a RhoMiddleware adding a route to get the Swagger json file representing the full API
def createSwagger(swaggerFormats: SwaggerFormats = DefaultSwaggerFormats, apiInfo: Info = ..., host: Option[String] = None, basePath: Option[String] = None, schemes: List[Scheme] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, security: List[SecurityRequirement] = Nil, securityDefinitions: Map[String, SecuritySchemeDefinition] = Map.empty, vendorExtensions: Map[String, AnyRef] = Map.empty)(routes: Seq[RhoRoute[F, _]]): Swagger

Create the swagger model for a set of routes.
def createSwaggerRoute(swagger: ⇒ Swagger, apiPath: TypedPath[F, HNil] = ...): RhoRoutes[F]

Create a RhoRoutes with the route to the Swagger json for the given Swagger Specification.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object SwaggerSupport | package swagger

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

Instance Constructors

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

Type Members

implicit class StrOps extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createSwaggerRoute(swagger: ⇒ Swagger, apiPath: TypedPath[F, HNil] = ...): RhoRoutes[F]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from SwaggerSyntax[F]

Inherited from AnyRef

Inherited from Any

Ungrouped