mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 23:02:54 +01:00
53f0d6320e
Co-Authored-By: kotte <14197736+mrtamagotchi@users.noreply.github.com> Co-Authored-By: mikaeltellhed <2311083+mikaeltellhed@users.noreply.github.com> Co-Authored-By: Tore Knudsen <18231882+torekndsn@users.noreply.github.com> Co-Authored-By: Michael Cartner <32543275+michaelcartner@users.noreply.github.com>
138 lines
6.1 KiB
Markdown
138 lines
6.1 KiB
Markdown
---
|
|
hide_title: true
|
|
title: REST
|
|
---
|
|
|
|
<##head##>
|
|
|
|
# REST
|
|
|
|
This node is used to connect to external [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) endpoints to make requests and expose data. It supports request content in **JSON** format.
|
|
|
|
<div className="ndl-image-with-background l">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
You initiate the request by sending a <span className="ndl-signal">signal</span> to the <span className="ndl-signal">Fetch</span> input. Any inputs and outputs to the node are specified in the `request` and `response` scripts.
|
|
|
|
<##head##>
|
|
|
|
## Request and response script
|
|
|
|
The REST node uses a script much like the [Script](/nodes/javascript/script) node to prepare the request and parse the response.
|
|
Any variables with the prefix **Inputs.** and **Outputs.** will be exposed as inputs and outputs to the node. So you can use these inputs in the request script to prepare the REST call, and the outputs in the response script to parse the response into outputs.
|
|
|
|
### Request
|
|
|
|
The first script is used to prepare the request before it is sent to the REST endpoint.
|
|
The _Inputs_ object contains the values of the inputs specified in the section above at the time the
|
|
request was initiated. The _Request_ object contains details on the request that can be adjusted if necessary.
|
|
|
|
- _resource_ - Contains the resource for the request, i.e. the URL.
|
|
- _method_ - Contains the method of the request.
|
|
- _headers_ - This is a map containing all headers to the request, add or remove headers in the function.
|
|
- _parameters_ - This is a map containing all parameters that will be appended to the URL of the request, add or remove in the function.
|
|
- _content_ - Contains the content of the request, the content will be encoded as JSON when the request is made.
|
|
|
|
The example below will create two inputs that you can connect to this node from other data in your applications. It modifies the headers and content for the request.
|
|
|
|
```javascript
|
|
Request.headers["some-important-header"] = Inputs.ImportantHeader;
|
|
Request.content = {
|
|
"send-me": Inputs.SendMe,
|
|
};
|
|
```
|
|
|
|
When the request is completed and we have a response the corresponding response function will be invoked.
|
|
|
|
### Response
|
|
|
|
In the response function, you can parse the response and set the appropriate outputs of the REST node using the _Outputs_ map
|
|
provided as an argument to the _response_ function. In the function, you will also have access to an object called _Response_ with the following content.
|
|
|
|
- _status_ - The status code of the response.
|
|
- _content_ - The content of the response.
|
|
- _request_ - This contains the request object from the _request_ function above that was used to make the request.
|
|
|
|
The REST node looks at the `Content-Type` header to determine how to parse the response from the server. If the type is JSON it will use `JSON.parse` and for XML it'll convert it to a JavaScript object.
|
|
|
|
#### Array Example
|
|
|
|
The following example assumes the response content is an array of objects.
|
|
It is converted to a Noodl Array with Noodl Objects and sends it to the output **Items**.
|
|
|
|
Example Response Content:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"MyValue": 1
|
|
},
|
|
{
|
|
"MyValue": 2
|
|
}
|
|
]
|
|
```
|
|
|
|
Script:
|
|
|
|
```javascript
|
|
Outputs.Items = Response.content.map((o) => Noodl.Object.create(o));
|
|
```
|
|
|
|
**Items** is now an array that can be sent to a Repeater or used in another node.
|
|
|
|
#### Object Example
|
|
|
|
The following example assumes the response content is an object.
|
|
It converts the object to a Noodl Object and sends it to the output **Items**.
|
|
|
|
Example Response Content:
|
|
|
|
```json
|
|
{
|
|
"title": "my title",
|
|
"description": "my cool description"
|
|
}
|
|
```
|
|
|
|
Script:
|
|
|
|
```javascript
|
|
Outputs.Item = Noodl.Object.create(Response.content);
|
|
```
|
|
|
|
We can also call `Response.content.description` immediately to extract certain properties.
|
|
|
|
## Inputs
|
|
|
|
| Signal | Description |
|
|
| ------------------------------------------ | --------------------------------------------------------- |
|
|
| <span className="ndl-signal">Fetch</span> | Connect a signal to this input to trigger a request. |
|
|
| <span className="ndl-signal">Cancel</span> | Send a signal to this input to cancel an ongoing request. |
|
|
|
|
| Data | Description |
|
|
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-data">Resource</span> | This is the resource endpoint that the REST request will use, i.e. the url. |
|
|
| <span className="ndl-data">Method</span> | This is the method that will be used for the request. Supported methods are GET, PUT, POST, PATCH and DELETE. |
|
|
| <span className="ndl-data">Request</span> | Here you can edit the request script. |
|
|
| <span className="ndl-data">Response</span> | Here you can edit the response script. |
|
|
|
|
### Request and response inputs
|
|
|
|
Any variable of the **Inputs** object that you access in your scrips will automatically become an input of the node.
|
|
|
|
## Outputs
|
|
|
|
| Signal | Description |
|
|
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-signal">Success</span> | A signal will be emitted on this output if the request receives a successful status code (2XX). |
|
|
| <span className="ndl-signal">Failure</span> | A signal will be emitted on this output on all other status codes of if another type of failure occurs. |
|
|
| <span className="ndl-signal">Canceled</span> | A signal will be emitted on this output if the request was canceled. |
|
|
|
|
### Request and response outputs
|
|
|
|
Any variable of the **Outputs** object that you access in your scrips will automatically become an output of the node.
|