Axway API Builder
Install the API Builder globally using
[sudo] npm install -g @axway/api-builder
api-builder CLI is installed, generate a new service called "myservice". It will create a new directory
./myservice and generate the service.
api-builder init myservice
Then install the service's dependencies and start the API Builder service.
cd ./myservicenpm install --no-optionalnpm start
Once it is running, you can open your browser to
http://localhost:8080/console to access the UI.
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.
Providing environment-specific configuration
You can choose which configuration values you want to be configurable from the environment by explicitly setting them at process.env. For example, to make the port configurable you could do:
// The port for the UIport: || 8000
api-builder init <dir>
Create an API Builder service.
dir - The directory to initialize.
Creates and initializes a new API Builder service by creating the service 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.
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.