@axway/api-builder

@axway/api-builder

Axway API Builder

Getting Started

Install the API Builder globally using npm.

[sudo] npm install -g @axway/api-builder

Scaffolding a new project

You could use api-builder CLI to generate a new service project.

api-builder init myservice

The CLI will create a new directory called ./myservice and initialize the new service.

Then you'll need to install the service's dependencies and start the API Builder service.

cd ./myservice
npm install --no-optional
npm start

Once it is running, you can open your browser to http://localhost:8080/console to access the UI.

Scaffolding a new flow-node plugin

You could use the api-builder CLI to generate a new flow-node plugin project.

api-builder plugin init myplugin

The CLI will create a new directory called ./api-builder-plugin-myplugin and initialize the new plugin.

Then you'll need to install the plugin's dependencies.

cd ./api-builder-plugin-myplugin
npm install
npm test

Running your API Builder service

Running an API Builder service will launch the runtime and the UI, which can be used to make changes to your service. By default, the service will bind to http://localhost:8080. If you wish to change this, see the following section on Providing environment-specific configuration.

CLI reference

api-builder init <dir>

Scaffolds an API Builder service project.

Arguments

dir - The project directory to create.

Description

Scaffolds a new API Builder service project in the in a directory specified by dir. The command will not run if the directory exists or if the command is run within an API Builder service directory.

api-builder plugin init <dir>

Scaffolds an API Builder plugin project.

Arguments

dir - The plugin directory to create.

Description

Scaffolds a new API Builder plugin project in the current directory with the provided plugin dir name. If dir is not prefixed with "api-builder-plugin-", it will be prefixed for you.

Author

Axway [e-mail] https://axway.com

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.