case class RouteSpec extends Product with Serializable
Encapsulates the specification of an HTTP endpoint, for use by either a Finagle server or client.
- Alphabetic
- By Inheritance
- RouteSpec
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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 at(method: Method): UnboundRoute0
-
def
body(bp: Body[_]): RouteSpec
Register the expected content of the body.
- val body: Option[Body[_]]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val consumes: Set[ContentType]
-
def
consuming(contentTypes: ContentType*): RouteSpec
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.
- val description: Option[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- 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
- val produces: Set[ContentType]
-
def
producing(contentTypes: ContentType*): RouteSpec
Register content types which thus route will produce.
Register content types which thus route will produce. This is informational only and NOT currently enforced.
- val requestParams: Seq[QueryOrHeader[_]]
- val responses: Map[Status, ResponseSpec]
-
def
returning(codeAndReason: (Status, String), example: String): RouteSpec
Register a possible response which could be produced by this route, with an example body (used for schema generation).
-
def
returning[T](codeAndReason: (Status, String), example: T, jsonLib: JsonLibrary[T, _] = Argo): RouteSpec
Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).
-
def
returning(response: Response): RouteSpec
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.
-
def
returning(codesAndReasons: (Status, String)*): RouteSpec
Register one or more possible responses which could be produced by this route.
-
def
returning(newResponse: ResponseSpec): RouteSpec
Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).
- val summary: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
taggedWith(tags: TagInfo*): RouteSpec
Add tags to this routes.
Add tags to this routes. Provides the ability to group routes by tag in a generated schema.
-
def
taggedWith(tag: String): RouteSpec
Add tags to this routes.
Add tags to this routes. Provides the ability to group routes by tag in a generated schema.
- val tags: Set[TagInfo]
-
def
taking(rp: QueryOrHeader[_]): RouteSpec
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.
-
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( ... )