Class/Object

io.fintrospect

RouteSpec

Related Docs: object RouteSpec | package fintrospect

Permalink

case class RouteSpec extends Product with Serializable

Encapsulates the specification of an HTTP endpoint, for use by either a Finagle server or client.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouteSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 at(method: Method): UnboundRoute0

    Permalink
  6. def body(bp: Body[_]): RouteSpec

    Permalink

    Register the expected content of the body.

  7. val body: Option[Body[_]]

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val consumes: Set[ContentType]

    Permalink
  10. def consuming(contentTypes: ContentType*): RouteSpec

    Permalink

    Register content types which the route will consume.

    Register content types which the route will consume. This is informational only and is NOT currently enforced.

  11. val description: Option[String]

    Permalink
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val produces: Set[ContentType]

    Permalink
  20. def producing(contentTypes: ContentType*): RouteSpec

    Permalink

    Register content types which thus route will produce.

    Register content types which thus route will produce. This is informational only and NOT currently enforced.

  21. val requestParams: Seq[QueryOrHeader[_]]

    Permalink
  22. val responses: Seq[ResponseSpec]

    Permalink
  23. def returning(code: (Status, String), example: String): RouteSpec

    Permalink

    Register a possible response which could be produced by this route, with an example body (used for schema generation).

  24. def returning[T](code: (Status, String), example: T, jsonLib: JsonLibrary[T, _] = Argo): RouteSpec

    Permalink

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  25. def returning(response: Response): RouteSpec

    Permalink

    Register an exact possible response which could be produced by this route.

    Register an exact possible response which could be produced by this route. Will be used for schema generation if content is JSON.

  26. def returning(codes: (Status, String)*): RouteSpec

    Permalink

    Register one or more possible responses which could be produced by this route.

  27. def returning(newResponse: ResponseSpec): RouteSpec

    Permalink

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  28. val summary: String

    Permalink
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def taking(rp: QueryOrHeader[_]): RouteSpec

    Permalink

    Register a header/query parameter.

    Register a header/query parameter. Mandatory parameters are checked for each request, and a 400 returned if any are missing.

  31. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped