abstract class SwaggerSupport[F[_]] extends SwaggerSyntax[F]
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- SwaggerSupport
- SwaggerSyntax
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new SwaggerSupport()(implicit F: Sync[F], etag: scala.reflect.api.JavaUniverse.WeakTypeTag[F[_]])
Type Members
- 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
- 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
- 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- 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.
- 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.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated