api-builder-plugin-gm-mustache

api-builder-plugin-gm-mustache

About

This module installs the Mustache flow-node to be used within Axway API Builder's flow editor.

The Mustache flow-node allows the evaluation of Mustache templates using values from the flow.

Format string

The Format string method evaluates the template given with the data supplied. This allows complex values to be constructed from values that exist in the flow's context.

Param	Type	Required	Description
data	object	y	The data to evaluate the template with. Use $ to access the entire context.
template	string	y	The template being evaluated.

Format object

The Format object method is similar to the Format string method. It evaluates the template given with the data supplied. However the resulting string value is then JSON parsed. This allows the creation of JavaScript values and objects from the evaluated template.

Param	Type	Required	Description
data	object	y	The data to evaluate the template with. Use $ to access the entire context.
template	string	y	The doT template being evaluated.

Mustache Templates

The Javascript implementation of Mustache being used is https://github.com/janl/mustache.js.

Example

In the examples the Flow is going to be attached to an API that has three parameters, firstname, lastname and gender.

Basic interpolation {{ }}

The template can be used to quickly concatenate values.

Request	http://localhost:8080/api/example?firstname=Clark&lastname=Kent&gender=m
data	$.params
template	{{firstname}} {{lastname}}
Output	Clark Kent

Conditionals {{^value}}{{/value}}

The template evaluation supports boolean checkes to tailor the output based on the input.

Request	http://localhost:8080/api/example?firstname=Clark&lastname=Kent&male=true
data	$
template	Hello {{#male}}Mr{{/male}}{{^male}}Ms{{/male}} {{surname}}
Output	Hello Mr Kent

Request	http://localhost:8080/api/example?firstname=Lois&lastname=Lane
data	$.params
template	Hello {{#male}}Mr{{/male}}{{^male}}Ms{{/male}} {{surname}}
Output	Hello Ms Lane

Array Iteration {{# }}

The template engine can also iterate over arrays, creating content for each element in the array.

Request	http://localhost:8080/api/example?names=Tom,Dick,Harry
data	$.params
template	{{#names}}{{.}} {{/names}}
Output	Tom Dick Harry

Getting started

1. Go to platform.axway.com and create an account
2. Install API Builder
3. Follow the Getting Started Guide

Install

After creating your API Builder project (appc new -t arrow), you can install this flow-node handler using npm:

npm install --save api-builder-plugin-gm-mustache

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