MBS Connector Plugin

The Mobile Backend Services (MBS) data connector is a plugin for API Builder that allows you to connect to Axway MBS. All the Models created in your project that uses the MBS data connector, will have their data automatically persisted in the cloud.

Installation

To install the MBS connector, execute the following command:

npm install --no-optional @axway/api-builder-plugin-dc-mbs

A configuration file is generated for you and placed into the /conf directory of your API Builder project.

Configuration

Once the plugin is installed, the configuration file is located in <project>/conf/mbs.default.js .

| Option name | Type | Description | Required | | ----------- | ---- | ----------- |---------- | connector | string | Must be set to @axway/api-builder-plugin-dc-mbs| Yes | | username | string | The user with which to connect to MBS. | Yes | | password | string | The user's password with which to connect to MBS. | Yes | | key | string | The MBS instance App Key | Yes | | baseurl | string | Location where MBS is hosted. Defaults to Amplify Platform Production | No | | pingInterval | number | The time in ms to ping MBS to keep the current session alive. Defaults to once a day. Set to -1 to disable. | No |

Provisioning a MBS database in the AMPLIFY Platform

1. Follow this guide to provision an MBS database and get a username, password and app key.
2. From within an API Builder 4.x project, install the connector:

$ npm install --no-optional @axway/api-builder-plugin-dc-mbs

After the successful installation of the connector, a configuration file 'mbs.default.js' will be automatically created in your project's conf directory.

We recommend providing the app key, username, and password as environment variables. MBS_KEY, MBS_USER and MBS_PASSWORD are the default environment variables used to configure this connector. See Environmentalization for more info.

After configuring the connector, you can start the service as normal.

Changes

1.1.0

• #6933: Replace peerDependency on @axway/api-builder-runtime with engines.apibuilder.

1.0.9

• #7343: Fix timing issue in unit tests.

1.0.8

• #7057: Updated documentation links.

1.0.7

• #7008: Fixed the issue where the plugin configuration file is not installed correctly if the project conf directory does not exist.

1.0.6

• #6934: Internal refactoring around code style.

1.0.5

• #6459: Added @axway/api-builder-project-utils to handle copying config to a project after installing this plugin.

1.0.4

• #6315: Internal chore.

1.0.3

• #6116: Internal cleanup chore.

1.0.2

• #6114: Refactor code for style, security and performance improvements.

1.0.1

• #6115: Internal fix for Sonar scans.

1.0.0

• #6107: Initial supported release.

0.1.2

• #6074: Internal CI chore.

0.1.1

• #6023: Add the ability to provide baseurl in configuration to specify an alternative MBS host.

0.1.0

• #5939: New connector implementation.

0.0.1 - 0.0.3

• No notable changes.

0.0.0

• #5776: Initial migration (unsupported).