@axway/api-builder-plugin-fn-restclient

api-builder-plugin-fn-restclient

About

This module installs the REST flow-node plugin to be used within Axway API Builder's flow editor. The flow-node provides methods for the HTTP verbs GET, HEAD, OPTIONS, DELETE, POST, PUT and PATCH.

Common Parameters

All methods have these parameters:

Param	Type	Required	Description
URL	string	y	The target HTTP URL.
Headers	object	n	The headers to send with the request.
Insecure	boolean	n	Do not require the SSL certificates to be valid. Default: False
Follow redirect	boolean	n	Follow HTTP 3xx responses as redirects. Default: True
Maximum redirects	integer	n	The maximum number of redirects to follow before aborting. Default: 10

Response format: HEAD, OPTIONS, DELETE

These verbs do not respond with a body. The response consists of {status, headers}.

Response format: GET, POST, PUT, PATCH

These verbs may respond with a body. The response consists of {status, headers, body}.

Getting started

1. Follow the Getting Started Guide

Install

npm install --no-optional @axway/api-builder-plugin-fn-restclient

The "REST" flow-node will then be available in the tools panel when creating or editing Flows.

Changes

3.2.1

• #7600: Fix @axway/requester explicit dependencies.

3.2.0

• #7599: Update @axway/requester.

3.1.0

• #7595: Update @axway/requester dependency.

3.0.2

• #7538: Update flow-node documentation to reflect default parameter values.
• #7538: Fixed an issue where the request content-length header was calculated incorrectly when the request body was a string that contains multi-byte characters.

3.0.1

• #7517: Update @axway/api-builder-sdk dependency.

3.0.0

• #6089: Breaking change: requires minimum Node.js version 16.x.

2.2.8

• #7538: Update flow-node documentation to reflect default parameter values.
• #7538: Fixed an issue where the request content-length header was calculated incorrectly when the request body was a string that contains multi-byte characters.

2.2.7

• #7470: Update @axway/api-builder-sdk dependency.

2.2.6

• #7466: Update @axway/api-builder-sdk dependency.

2.2.5

• #7474: Internal dev-dependency move.

2.2.4

• #7412: Pin in-house dependencies.

2.2.3

• #7411: Internal bump.

2.2.2

• #7403: Internal dev-dependency change.

2.2.1

• #7345: Internal dependency bump.

2.2.0

• #6933: Replace peerDependency on @axway/api-builder-runtime with engines.apibuilder.

2.1.0

• #7226: Methods delete and options now support response body.

2.0.27

• #7155: Fixed issue with CVE-2021-3918 and removed the dependency on the request library.

2.0.26

• #7057: Updated documentation links.

2.0.25

• #7034: Internal refactor of unit-tests.

2.0.24

• #7010: Internal refactor of unit-tests.

2.0.23

• #6934: Internal refactoring around code style.

2.0.22

• #6416: Migrate from axway-flow-sdk to @axway/api-builder-sdk@1.0.0.

2.0.21

• #6315: Internal chore.

2.0.20

• #6277: Internal bump

2.0.18

• #6265: Fixes in the readme.

2.0.17

• #6116: Internal cleanup chore.

2.0.16

• #6074: Internal CI chore

2.0.9 - 2.0.15

• #5891: Bump axway-flow-sdk dependency

2.0.8

• #5742: Fix issue where axway-flow-sdk dependency was out of sync with the latest. dot security warning is now resolved.

2.0.7

• #5711: Internal cleanup of npm scripts.

2.0.6

• #5708: Internal changes to update mocha configuration

2.0.5

• #5709: Internal changes to update eslint rules.

2.0.4

• #5707: Internal cleanup to code coverage during build process.

2.0.3

• #5742: Update axway-flow-sdk dependency to remove security warning about dot package.

2.0.1

• #5515: Fix REST response encoding typo.

2.0.0

• #5436: Breaking Change: Moves advanced HTTP options into a new group, "Advanced HTTP Options" (minimum peer dependency @axway/api-builder-runtime 4.5.0)

1.2.0

• #5172: Support downloading binary files in REST node.

1.1.0

• #5178: Adds support for communication via proxy server. It takes into account the value of config parameter named proxy which must contain the location of a proxy server through which communication is tunneled. Basic auth is also supported if the value of the proxy is of the format - 'protocol://username:password@location:port'

1.0.14

• #5050: Updating license text.

1.0.8

• #4757: Changed SCM repository and associated internal cleanup.

License

This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here: https://support.axway.com/en/auth/general-conditions; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.