Nodes

Overview

In ION, we use Nodes which are modular functional blocks, to quickly create API workflows. These nodes are configurable and designed to abstract complex API logics, making API development more convenient. The platform is suited for both experienced developers and individuals with minimal coding experience, facilitating the API development process.

Choice of Language

ION's nodes are developed using TypeScript to enhance the development experience and improve code quality. The use of TypeScript's static typing helps create a more robust, error-resistant codebase and improves both readability and maintainability.

Parts of a Node

A node is composed of several parts: Header, Properties, Steps and Output.

Header

The top part of a node holds useful details like the node's name or identifier. It indicates the function you want to run and the current version. Each Node uses a background color that indicate the Node category. The pencil icon allows to edit the configuration or for quick access, double click on the header.By default, when you add a Node in the Canvas, ION adds a random name for every node. This makes it easier to identify a node within the workflow. You can change it from the Edit panel.

Properties

Properties are grouped for used within the Node.Hover over the properties to see their values.

Steps

There are nodes that also have Steps. In the Steps, you can add nodes that will run within the Node during the execution of any workflow.

Not all nodes include steps.

Output

This is the last property of a Node. It identifies the output of a Node.\

Node execution order

Some nodes include steps, such as in this example, to provide insight into their execution flow. Essentially, all nodes connected to the body of the node will be executed first. If the node has another node connected to its header, it will be executed after all the other nodes. This sequential execution ensures the orderly processing of tasks within the workflow.

Updating Node properties

To update a Node's property, double-click on the header or click the pencil icon.This opens a drawer on the right side of the canvas and includes all the properties available for you to configure.

After updating the node's properties, click Save to apply the changes (Note: This does not deploy the workflow) or click cancel if you want to discard them. Once you save, the changes will be applied to the Node's properties and now you can hover over them to view the values.

Node Documentation

If you require additional information about the functionality and specifics related to any node, you can click on the Documentation tab in the edit panel and view all the resource guide. The documentation includes all the relevant instructions, examples, and explanations that you might need.

For more information about how to update node properties you can check How to configure a Node section