Plugin: ServiceThing

Version
0.1.1
Size
16 k
Author
ambitionframework.org <ambitionframework -dot- org>
Description
Easy Services for Ambition
Last Updated
2014-10-27
Views
749

ServiceThing

What is it for?

The ServiceThing plugin allows for the easy creation of services and RESTful APIs.

Installation and Configuration

The ServiceThing plugin can be installed using the usual Ambition plugin tool. The plugin will link with your application.

Quick Example

In actions.conf:

/service    GET   Service:Root.service
/service    POST  Service:Root.change_service

In Root.vala:

public Object service( State state ) {
    var to = new TestResponseObject();
    to.some_response = "Test";
    return to;
}

public Object change_service( State state ) {
    var req_object = ServiceThing.get_request_object<TestRequestObject>(state);
    if ( req_object != null ) {
        var to = new TestResponseObject();
        to.some_response = req_object.some_value;
        return to;
    }
    return null;
}

Elsewhere:

public class TestRequestObject : Object {
    public string some_value { get; set; }
}
public class TestResponseObject : Object {
    public string some_response { get; set; }
}

Responses:

$ curl -X GET --header "Accept: application/json" \\
  http://localhost:8099/service
{"some_response":"Test"}

$ curl -X POST --header "Content-Type: application/json" \\
  --header "Accept: application/json" http://localhost:8099/service \\
  -d '{"some_value":"woo"}' 
{"some_response":"woo"}