Skip to main content

Introduction

About#

Ignite openAPI allows you to work with APIs defined by OpenAPI 3 (Swagger). You can set parameters within the Node-RED-UI and trigger the flow from within your flow.

It is based on swagger-js.

Nodes#

Ignite openAPI contains two nodes.

OpenAPI router#

This node creates end points within ignite runtime, based on the openAPI URL provided.

img

OpenAPI client#

This node is used to load and hit open API end points.

img

Parameter Configuration#

Each parameter has an input-field corresponding to its type. You can further define that a parameter shall be read from the incoming message object or define a JSONata expression.

JSON parameters may define a sample structure. You can set this as the value by clicking the corresponding button - either with only the required keys (set required) or with all keys (set default).

Authentication#

If the API requires an authentication token, you can log in using the standard http-request node of Node-RED. The JWT token you get as a response must then be put into msg.openApiToken to be automatically placed in the request-header as bearer authentication.

Error Handling#

You can choose how to handle a returning server error. The last server response object will be placed in msg.response instead of msg.error. This ensures that all 3 ways react the same.

  • Standard: The flow moves on normally. You have to handle an server error in your flow.
  • Separate output: Your flow will take a different way.
  • Throw an exception: Throws an node.error which can be catch by the standard 'catch' node (useful for many nodes with the same error handling).

How to Install#

img