This module is in Maintenance LTS mode, new features are no longer accepted. (See Module Long Term Support Policy below.) LoopBack 3 users looking for new features are encouraged to upgrade to LoopBack 4. Refer to loopback-next#1849 for more information on how to upgrade.
loopback-workspace module provides node.js and REST APIs for interacting
with a set of loopback components. Components are organized in the following
basic directory structure:
/my-workspace /my-component-a /my-component-b /my-component-c package.json
Each component has the following basic structure:
/my-component config.json datasources.json model-config.json /models my-model.json my-model.js
loopback-workspace itself is a loopback component. The following
will load the workspace in the current working directory (
// workspace is a loopback `app` object var workspace = require('loopback-workspace');
Custom Workspace Directory
To start the workspace in a specific directory, specify the
In order to use the REST api, mount the app on an existing express app or call
To run end-to-end tests, you will need a local MySQL instance.
node test/helpers/setup-mysql.js to create a test database and
a test user. This is a one-time task to run only once when setting up your
npm test command to run the tests.
This module adopts the Module Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:
|4.x||Maintenance LTS||Sep 2017||Dec 2020|
|3.x||End-of-Life||Jul 2014||Apr 2019|
Learn more about our LTS plan in the docs.