@axway/amplify-api-builder-cli

@axway/amplify-api-builder-cli

An installable API Builder Standalone CLI package for the Axway AMPLIFY CLI.

Installation

Assuming you are familiar with Node.js and npm, you should first install the Axway AMPLIFY CLI, which will give you connectivity to the Axway AMPLIFY Platform. Note that you must first have an account on https://platform.axway.com, and be provisioned in API Central:

$ [sudo] npm install -g @axway/amplify-cli

Use the AMPLIFY package manager command to install the API Builder Standalone command line:

$ amplify pm install @axway/amplify-api-builder-cli

Getting started

Using the API Builder Standalone CLI, you can create a new project and initialize it with proxy services available from API Central. Log in to the Axway AMPLIFY Platform production server using the following command:

$ amplify auth login --env prod --client-id apicentral

Then, initialize a new API Builder Standalone project and specify the --get-catalog option. This will use the current AMPLIFY user session to download the proxy services available from API Central. The command will create the project, download the proxy services, and execute an npm install in the myproject directory.

$ amplify builder init --get-catalog myproject
$ cd myproject
$ npm 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. Any time you wish to start the service, change directory into your project and execute:

$ npm start

Then, open a browser to: http://localhost:8080/console

CLI reference

amplify builder init [--get-catalog] <dir>

Create an API Builder service.

Options

--get-catalog - Uses an existing authenticated login to access API Central to download the API Catalog for use within API Builder.

Arguments

dir - The directory to initialize.

Description

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.

Example

Initialize a new project directory and download the API Catalog (requires login):

$ amplify builder init --get-catalog myproject

Initialize a new project directory:

$ amplify builder init myproject

amplify builder get-catalog

Download the API Catalog from API Central into an existing project directory.

Description

A valid AMPLIFY user login is required to use this command. It will connect to API Central and download and install the API Catalog into an existing project directory. You must be in your project directory to execute this command.

Example

Download and install the API Catalog into an existing project (requires login):

$ amplify builder get-catalog

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.