apic-dp-js-policy

API Connect DataPower custom gatewayscript policy maker

Installation

npm i -g apic-dp-js-policy

Usage

(1) Create a folder with the script's name (no spaces, all lowercase and hyphens), This name will be further referred as {projName} (for example: hello-world).

(2) Create a JavaScript file in that folder named {projName}.js (e.g. hello-world.js)

JavaScript file example:

// API Connect utility
const apic = require('local://isp/policy/apim.custom.js');
// helper module to manipulate headers
const hm = require('header-metadata');

// Get extension properties
const props = apic.getPolicyProperty();
const message = props.message;

// Set the response header
hm.current.set('X-Hello-World', message);

request.body

Note you cannot get the request body using apim.getvariable('request.body'). You should use apim.readInput or apim.readInputAs<Type> instead.

(3) Create a yaml file in that folder named {projName}.yaml (e.g. hello-world.yaml)

YAML file example:

policy: 1.0.0

info:
  title: hello-world
  name: hello-world
  version: 1.0.0
  description: Hello World Extension

attach:
  - rest
  - soap

gateways:
  - datapower-gateway

properties:
  $schema: "http://json-schema.org/draft-04/schema#"
  type: object
  properties:
    message:
      label: Message to be returned
      description: A message to be returned in the X-Hello-World header
      type: string
      default: oh-hi
  required:
    - message

• Notice info.name must be the {projName}

(4) You will now have the following folder structure:

  hello-world/
    hello-world.js
    hello-world.yaml

• Note: Any other file in that folder would be added to the policy's folder, so you could add js files to require from your code.

Run the following command from outside that folder:

apic-dp-js-policy --project {projName}

(e.g. apic-dp-js-policy -p hello-world)

Arguments

|Argument |Required|Default|Description |-------------|--------|-------|----------- |-p/--path|Yes | - |The project's path |-n/--name|No |path.basename(argv.path)| |-h/--hashLength|No | 6 | Number of characters from the hash of the main js file to add to the result file's name |-t/--timestamp|No |false| Use timestamp (i.e. 2019-07-17T12-00-00-000Z) instead of hash in the zip file name

e.g. The result file name would look like:

policy-hello-world_v1.0.0-x2GTXy.zip

Credits

Eli Sherer

License

MIT