Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add http proxy cababitlity for rest-activity #151

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add http proxy cababitlity for rest-activity #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 50 additions & 83 deletions activity/rest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,57 @@
<!--
title: REST
weight: 4618
-->
# REST Activity
This activity allows you to invoke a REST service.
It will pass through the uri and reads the domain:port from an application configuration if configured via the path settings, e.g.:
`{schemadomainnameport}/` where `schemadomainnameport` is the application property value.
The setting `` needs to be set to yes to function.

# REST
This activity allows you to invoke a REST service.

## Installation
# Installation
flogo install github.com/project-flogo/contrib/activity/rest

### Flogo CLI
## TIBCO sandbox manual installation
```bash
flogo install github.com/project-flogo/contrib/activity/rest
zip the 'rest' directory (including the directory 'rest' )
Go to https://eu.integration.cloud.tibco.com/envtools/flogo_extensions and upload the zip
ensure to increase the version nr in the description.json before uploading to distingues between versions
```

## Configuration

### Settings:
| Name | Type | Description
|:--- | :--- | :---
| method | string | The HTTP method to invoke (Allowed values are GET, POST, PUT, DELETE, and PATCH) - **REQUIRED**
| uri | string | The URI of the service to invoke - **REQUIRED**
| headers | params | The HTTP header parameters
| proxy | string | The address of the proxy server to be used
| timeout | int | The request timeout in seconds
| sslConfig | object | SSL configuration

#### *sslConfig* Object:
| Property | Type | Description
|:--- | :--- | :---
| skipVerify | bool | Skip SSL validation, defaults to true
| useSystemCert | bool | Use the systems root certificate file, defaults to true
| caFile | string | The path to PEM encoded root certificates file
| certFile | string | The path to PEM encoded client certificate
| keyFile | string | The path to PEM encoded client key
# Configuration
## Settings:
| Name | Type | Description |
|------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| method | string | The HTTP method to invoke (Allowed values are GET, POST, PUT, DELETE, PATCH, TRIGGER) - **REQUIRED** <br/>When TRIGGER is selected, the actual method is taken from the incoming trigger |
| useEnvProp | boolean | define if you want to replace the schema://hostname:port part with the environment variable |
| uri | string | The URI of the service to invoke - **REQUIRED** <br> When the uri start with an { it is seen as the start of a applciation property. So {ap} where ap is the applciation property defined to replace runtime |
| headers | params | The HTTP header parameters |
| proxy | string | The address of the proxy server to be used |
| timeout | int | The request timeout in seconds |
| sslConfig | object | SSL configuration |


## *sslConfig* Object:
| Property | Type | Description |
|---------------|--------|---------------------------------------------------------|
| skipVerify | bool | Skip SSL validation, defaults to true |
| useSystemCert | bool | Use the systems root certificate file, defaults to true |
| caFile | string | The path to PEM encoded root certificates file |
| certFile | string | The path to PEM encoded client certificate |
| keyFile | string | The path to PEM encoded client key |

*Note: used if URI is https*
### Input:
| 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
| content | any | The message content to send. This is only used in POST, PUT, and PATCH

### Output:
| Name | Type | Description
|:--- | :--- | :---
| status | int | The HTTP status code
| data | any | The HTTP response data
| headers | params | The HTTP response headers
| cookies | array | The response cookies (from 'Set-Cookie')

## Examples
### Simple
The below example retrieves a pet with number '1234' from the [swagger petstore](http://petstore.swagger.io):

```json
{
"id": "rest_activity",
"name": "REST Activity",
"activity": {
"ref": "github.com/project-flogo/contrib/activity/rest",
"settings": {
"method": "GET",
"uri": "http://petstore.swagger.io/v2/pet/1234"
}
}
}
```

### Using Path Params
The below example is the same as above, it retrieves a pet with number '1234' from the [swagger petstore](http://petstore.swagger.io), but uses a URI parameter to configure the ID:

```json
{
"id": "rest_activity",
"name": "REST Activity",
"activity": {
"ref": "github.com/project-flogo/contrib/activity/rest",
"settings": {
"method": "GET",
"uri": "http://petstore.swagger.io/v2/pet/:id"
},
"input": {
"params": { "id": "1234"}
}
}
}
```
## Input:
| 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 method coming in from the trigger; Only used if 'TRIGGER' is selected |
| content | any | The message content to send. This is only used in POST, PUT, and PATCH |
| envPropUri | string | Connect the availalbe environment variable into this activity |


## Output:
| Name | Type | Description |
|---------|--------|------------------------------------------|
| status | int | The HTTP status code |
| data | any | The HTTP response data |
| headers | params | The HTTP response headers |
| cookies | array | The response cookies (from 'Set-Cookie') |
Loading