REST Trigger

This trigger provides your flogo application the ability to start an action via REST over HTTP

This is a fork from https://github.com/project-flogo/contrib/tree/master/trigger/rest

This version updated the descriptor.json, so app models can be imported to Flogo Enterprise when app properties are used in trigger settings.

Installation

flogo install github.com/open-dovetail/dovetail-contrib/trigger/rest

Configuration

Settings:

Name	Type	Description
port	int	The port to listen on - REQUIRED
enableTLS	bool	Enable TLS on the server
certFile	string	The path to PEM encoded server certificate
keyFile	string	The path to PEM encoded server key

Handler Settings:

Name	Type	Description
method	string	The HTTP method (ie. GET,POST,PUT,PATCH or DELETE) - REQUIRED
path	string	The resource path - REQUIRED

Output:

Name	Type	Description
pathParams	params	The path parameters (e.g., 'id' in http://.../pet/:id/name )
queryParams	params	The query parameters (e.g., 'id' in http://.../pet?id=someValue )
headers	params	The HTTP header parameters
method	string	The HTTP method used for the request
content	any	The content of the request

Reply:

Name	Type	Description
code	int	The http code to reply with
data	any	The data to reply with
headers	params	The HTTP response headers
cookies	params	The HTTP response cookies to set (uses 'Set-Cookie' headers)

Example Configurations

Triggers are configured via the triggers.json of your application. The following are some example configuration of the REST Trigger.

POST

Configure the Trigger to handle a POST on /device

{
  "triggers": [
    {
      "id": "flogo-rest",
      "ref": "github.com/open-dovetail/dovetail-contrib/trigger/rest",
      "settings": {
        "port": 8080
      },
      "handlers": [
        {
          "settings": {
            "method": "POST",
            "path": "/device"
          },
          "action": {
            "ref": "github.com/project-flogo/flow",
            "settings": {
              "flowURI": "res://flow:new_device_flow"
            }
          }
        }
      ]
    }
  ]
}

GET

Configure the Trigger to handle a GET on /device/:id

{
  "triggers": [
    {
      "id": "flogo-rest",
      "ref": "github.com/open-dovetail/dovetail-contrib/trigger/rest",
      "settings": {
        "port": 8080
      },
      "handlers": [
        {
          "settings": {
            "method": "GET",
            "path": "/device/:id"
          },
          "action": {
            "ref": "github.com/project-flogo/flow",
            "settings": {
              "flowURI": "res://flow:get_device_flow"
            },
            "input": {
              "deviceId": "=$.pathParams.id"
            }
          }
        }
      ]
    }
  ]
}