@axway/api-builder-admin

@axway/api-builder-admin

API Builder development UI and API

Features

• Install alongside API Builder to activate a UI for service development and administration at runtime.
• This should be installed as a dev dependency so it is not included or running in production builds.

Install

npm install --save-dev @axway/api-builder-admin

API Reference

Administration package for API Builder developent at runtime. Includes the admin ui and api.

@axway/api-builder-admin~Admin

Kind: inner class of @axway/api-builder-admin

• ~Admin
  • new Admin()
  • .resolveAllowedHosts(apibuilder, allowedHosts, next)
  • .getAccessControlMiddleware(apibuilder, allowedIps) ⇒ function
  • .start(apibuilder, callback)
  • .stop(callback)

new Admin()

Administration console.

admin.resolveAllowedHosts(apibuilder, allowedHosts, next)

Gets a list of IPs which are allowed hosts. If API Builder is configured to allow any hostnames, they will be resolved as IPs.

Kind: instance method of Admin

Param	Type	Description
apibuilder	APIBuilder	API Builder server
allowedHosts	array | string	hostname, or array of hostnames/ips to resolve
next	function	callback

admin.getAccessControlMiddleware(apibuilder, allowedIps) ⇒ function

Returns express middleware which limits access to a subset of allowed IPs

Kind: instance method of Admin
Returns: function - access control express middleware

Param	Type	Description
apibuilder	APIBuilder	API Builder server
allowedIps	array	arrays to limit route access to

admin.start(apibuilder, callback)

Start the admin

Kind: instance method of Admin

Param	Type	Description
apibuilder	object	API Builder instance
callback	function	callback

admin.stop(callback)

Stop the admin.

Kind: instance method of Admin

Param	Type	Description
callback	function	callback

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.