DescribedRoute

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def at(method: HttpMethod): IncompletePath0

   

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

   

   Register the expected content of the body.

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

   

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. val consumes: Set[ContentType]

   

10. def consuming(contentTypes: ContentType*): DescribedRoute

    

    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. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

14. val headerParams: Seq[HeaderParameter[_]]

    

15. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

16. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

17. final def notify(): Unit

    

    Definition Classes

    AnyRef

18. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

19. val produces: Set[ContentType]

    

20. def producing(contentTypes: ContentType*): DescribedRoute

    

    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 queryParams: Seq[QueryParameter[_]]

    

22. val responses: Seq[ResponseWithExample]

    

23. def returning(code: (HttpResponseStatus, String), example: JsonNode): DescribedRoute

    

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

24. def returning(response: HttpResponse): DescribedRoute

    

    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.

25. def returning(codes: (HttpResponseStatus, String)*): DescribedRoute

    

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

26. def returning(newResponse: ResponseWithExample): DescribedRoute

    

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

27. val summary: String

    

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

    

    Definition Classes

    AnyRef

29. def taking(rp: QueryParameter[_]): DescribedRoute

    

    Register a query parameter.

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

30. def taking(rp: HeaderParameter[_]): DescribedRoute

    

    Register a header parameter.

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

31. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )