Class/Object

org.http4s.rho.swagger

SwaggerSupport

Related Docs: object SwaggerSupport | package swagger

Permalink

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. All

Instance Constructors

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

    Permalink

Type Members

  1. implicit class ListOps extends AnyRef

    Permalink

    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

    Permalink

    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

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. 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]

    Permalink

    Create a RhoMiddleware adding a route to get the Swagger json file representing the full API

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

    Permalink

    Create the swagger model for a set of routes.

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

    Permalink

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

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from SwaggerSyntax[F]

Inherited from AnyRef

Inherited from Any

Ungrouped