Start development of 2.x

This commit is contained in:
Miroslav Bajtoš 2016-09-01 09:39:02 +02:00
parent c724d31f0e
commit 5882ea413f
3 changed files with 15 additions and 7 deletions

View File

@ -14,3 +14,7 @@ node_modules
coverage
*.tgz
*.xml
test
.travis.yml
test
.travis.yml

View File

@ -2,6 +2,9 @@
Remote REST API connector for [loopback-datasource-juggler](https://github.com/strongloop/loopback-datasource-juggler).
- The version range 2.x is compatible with LoopBack v3 and newer.
- Use the older range 1.x for applications using LoopBack v2.
## Quick Explanation
Use this connector to create a datasource from another Loopback application. Below is a quick example:
@ -13,26 +16,26 @@ Use this connector to create a datasource from another Loopback application. Be
"connector": "remote"
}
```
Note that you should add a `url` property to point to another remote service.
Note that you should add a `url` property to point to another remote service.
If you do not specify a `url` property, the remote connector will point to it's own host name, port it's running on, etc.
The connector will generate models on the MyMicroService datasource object based on the models/methods exposed from the remote service. Those models will have methods attached that are
from the model's remote methods. So if you exposed a remote method from that micro-service called `bar` from the model `foo`,
The connector will generate models on the MyMicroService datasource object based on the models/methods exposed from the remote service. Those models will have methods attached that are
from the model's remote methods. So if you exposed a remote method from that micro-service called `bar` from the model `foo`,
the connector will automatically generate the following:
`app.datasources.MyMicroService.models.foo.bar()`
### Access it in any model file
To access the remote Loopback service in a model:
To access the remote Loopback service in a model:
```javascript
module.exports = function(Message) {
Message.test = function (cb) {
Message.app.datasources.MyMicroService.models.SomeModel.remoteMethodNameHere(function () {});
cb(null, {});
};
};
```

View File

@ -1,6 +1,7 @@
{
"name": "loopback-connector-remote",
"version": "1.3.2",
"version": "2.0.0-alpha.1",
"pubishConfig": { "tag": "next" },
"description": "Remote REST API connector for Loopback",
"main": "index.js",
"keywords": [