Update api.md
Add .use() to API ref, moved from orphaned heading.
This commit is contained in:
parent
5a8ed83d5f
commit
a8d910a041
26
docs/api.md
26
docs/api.md
|
@ -50,7 +50,7 @@ models.forEach(function (Model) {
|
||||||
|
|
||||||
#### app.docs(options)
|
#### app.docs(options)
|
||||||
|
|
||||||
Enable swagger REST api documentation.
|
Enable swagger REST API documentation.
|
||||||
|
|
||||||
**Options**
|
**Options**
|
||||||
|
|
||||||
|
@ -65,6 +65,18 @@ app.docs({basePath: 'http://localhost:3000'});
|
||||||
|
|
||||||
Run your app then navigate to [the api explorer](http://petstore.swagger.wordnik.com/). Enter your API basepath to view your generated docs.
|
Run your app then navigate to [the api explorer](http://petstore.swagger.wordnik.com/). Enter your API basepath to view your generated docs.
|
||||||
|
|
||||||
|
#### app.use( router )
|
||||||
|
|
||||||
|
Expose models over specified router.
|
||||||
|
For example, to expose models over REST using the `loopback.rest` router:
|
||||||
|
|
||||||
|
```js
|
||||||
|
app.use(loopback.rest());
|
||||||
|
```
|
||||||
|
|
||||||
|
View generated REST documentation by visiting: [http://localhost:3000/_docs](http://localhost:3000/_docs).
|
||||||
|
|
||||||
|
|
||||||
### Model
|
### Model
|
||||||
|
|
||||||
A Loopback `Model` is a vanilla JavaScript class constructor with an attached set of properties and options. A `Model` instance is created by passing a data object containing properties to the `Model` constructor. A `Model` constructor will clean the object passed to it and only set the values matching the properties you define.
|
A Loopback `Model` is a vanilla JavaScript class constructor with an attached set of properties and options. A `Model` instance is created by passing a data object containing properties to the `Model` constructor. A `Model` constructor will clean the object passed to it and only set the values matching the properties you define.
|
||||||
|
@ -1081,15 +1093,3 @@ Various APIs in Loopback accept type descriptions (eg. [remote methods](#remote-
|
||||||
- `Date` - a JavaScript date object
|
- `Date` - a JavaScript date object
|
||||||
- `Buffer` - a node.js Buffer object
|
- `Buffer` - a node.js Buffer object
|
||||||
- [GeoPoint](#geopoint) - A Loopback GeoPoint object.
|
- [GeoPoint](#geopoint) - A Loopback GeoPoint object.
|
||||||
|
|
||||||
### REST Router
|
|
||||||
|
|
||||||
Expose models over rest using the `loopback.rest` router.
|
|
||||||
|
|
||||||
```js
|
|
||||||
app.use(loopback.rest());
|
|
||||||
```
|
|
||||||
|
|
||||||
**REST Documentation**
|
|
||||||
|
|
||||||
View generated REST documentation by visiting: [http://localhost:3000/_docs](http://localhost:3000/_docs).
|
|
||||||
|
|
Loading…
Reference in New Issue