rest

Type Members

1. sealed trait ArgumentType extends AnyRef

   

2. class Body extends Annotation with MetadataAnnotation with ArgumentType

   

   Annotated argument will be send as a body, eg.

   Annotated argument will be send as a body, eg. /method/ JSON(value). Only one argument can be annotated. It cannot be mixed with @BodyValue.

3. class BodyValue extends Annotation with MetadataAnnotation with ArgumentType

   

   Annotated argument will be send as a body part, eg.

   Annotated argument will be send as a body part, eg. /method/ JSON(arg -> value). It can be used on multiple arguments. It cannot be mixed with @Body.

4. class DELETE extends Annotation with MetadataAnnotation with RESTMethod

   

   Annotated method will be send using DELETE HTTP method.

5. class DefaultRESTConnector extends RESTConnector

   

   Default implementation of io.udash.rest.internal.RESTConnector for Udash REST.

6. class DefaultServerREST[ServerRPCType] extends UsesREST[ServerRPCType] with RESTConverters

   

   Default REST usage mechanism using io.udash.rest.DefaultRESTFramework.

7. class GET extends Annotation with MetadataAnnotation with RESTMethod

   

   Annotated method will be send using GET HTTP method.

   Annotated method will be send using GET HTTP method. It's a default for requests without body.

8. class Header extends Annotation with MetadataAnnotation with ArgumentType

   

   Annotated argument will be send as a header.

9. class PATCH extends Annotation with MetadataAnnotation with RESTMethod

   

   Annotated method will be send using PATCH HTTP method.

10. class POST extends Annotation with MetadataAnnotation with RESTMethod

    

    Annotated method will be send using POST HTTP method.

    Annotated method will be send using POST HTTP method. It's a default for requests with body.

11. class PUT extends Annotation with MetadataAnnotation with RESTMethod

    

    Annotated method will be send using PUT HTTP method.

12. class Query extends Annotation with MetadataAnnotation with ArgumentType

    

    Annotated argument will be send as a query argument, eg.

    Annotated argument will be send as a query argument, eg. /method/?arg=value. It's a default argument type.

13. class REST extends RPC

    

    Marker trait for REST interfaces.

14. trait RESTConverters extends AnyRef

    

15. sealed trait RESTMethod extends AnyRef

    

16. class RESTName extends Annotation with MetadataAnnotation

    

    Forces name of a method used in the interface to REST mapping.

    Forces name of a method used in the interface to REST mapping. This annotation has no effect on exposed interface, it should be used in case of wrapping external API. If you want to overwrite method name in exposed interface you should use @RPCName annotation.

17. class RESTParamName extends Annotation with MetadataAnnotation

    

    Forces name of an argument used in the interface to REST mapping.

    Forces name of an argument used in the interface to REST mapping. It also affects exposed interfaces.

18. class SkipRESTName extends Annotation with MetadataAnnotation

    

    Annotated method name will be skipped in the REST path.

    Annotated method name will be skipped in the REST path. This annotation cannot be used in interface which you are going to expose. It should be used in case of wrapping external API.

19. class URLPart extends Annotation with MetadataAnnotation with ArgumentType

    

    Annotated argument will be send as an URL part, eg.

    Annotated argument will be send as an URL part, eg. /method/{value}.

20. trait UdashRESTFramework extends GetterRPCFramework with ProcedureRPCFramework with FunctionRPCFramework