c

com.avsystem.commons.rest

BodyMethodTag

sealed abstract class BodyMethodTag extends HttpMethodTag

Base trait for annotations representing HTTP methods which may define a HTTP body. This includes PUT, POST, PATCH and DELETE. Parameters of REST methods annotated with one of these tags are by default serialized into JSON (through encoding to JsonValue) and combined into JSON object that is sent as HTTP body.

Parameters may also contribute to URL path, HTTP headers and query parameters if annotated as Path, Header or Query.

REST method may also take a single parameter representing the entire HTTP body. Such parameter must be annotated as Body and must be the only body parameter of that method. Value of this parameter will be encoded as HttpBody which doesn't necessarily have to be JSON (it may define its own MIME type).

Example:
  1. trait SomeRestApi {
      @POST("users/create") def createUser(@Body user: User): Future[Unit]
      @PATCH("users/update") def updateUser(id: String, name: String): Future[User]
    }
    object SomeRestApi extends RestApiCompanion[SomeRestApi]
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BodyMethodTag
  2. HttpMethodTag
  3. AnnotationAggregate
  4. RestMethodTag
  5. RpcTag
  6. RealSymAnnotation
  7. StaticAnnotation
  8. Annotation
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Implied

    Dummy type member meant to be redefined in order to have aggregated annotations applied on it.

    Dummy type member meant to be redefined in order to have aggregated annotations applied on it. These annotations will be automatically picked up by macro engines each time they encounter the aggregating annotation itself. Other than being an "anchor" for annotations, this type member has no actual meaning and there is no reason to ever actually use it. NOTE: a less weird solution would be to put aggregated annotations on the aggregating annotation class itself, but this would make it impossible to access the arguments of aggregating annotation in aggregated annotations.

    Definition Classes
    AnnotationAggregate

Abstract Value Members

  1. abstract def path: String

    HTTP URL path segment associated with REST method annotated with this tag.

    HTTP URL path segment associated with REST method annotated with this tag. This path may be multipart (i.e. contain slashes). It may also be empty which means that this particular REST method does not contribute anything to URL path. Any special characters will be URL-encoded when creating HTTP request. If path is not specified explicitly, method name is used (the actual method name, not rpcName).

    Definition Classes
    RestMethodTag
    Annotations
    @defaultsToName()
    Example:
    1. trait SomeRestApi {
        @GET("users/find")
        def findUser(userId: String): Future[User]
      }
      object SomeRestApi extends RestApiCompanion[SomeRestApi]

Concrete 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 clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val method: HttpMethod
    Definition Classes
    HttpMethodTag
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from HttpMethodTag

Inherited from AnnotationAggregate

Inherited from RestMethodTag

Inherited from RpcTag

Inherited from RealSymAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped