Standardized API Development using Node.js

Intro Installation and conﬁguration Query data Conclusion
Standardized API Development
Nicolas De Smyter
FDS
March 17, 2017

1 Intro
2 Installation and configuration
First setup
Configure database
Configure model
User implemented method
Start API server
3 Query data
4 Conclusion
Further reading

Loopback
LoopBack is a highly-extensible, open-source Node.js framework
that enables you to create dynamic end-to-end REST APIs with
little or no coding.

First setup
$ npm install -g loopback-cli
$ lb

Conﬁgure database
$ lb datasource
? Enter the data-source name: postgres-db
? Select the connector for oracledb: PostgreSQL
Connector specific configuration:
? Connection String url to override other settings:
postgres://postgres:postgres@localhost/mantis
? host: localhost
? port: 5432
? user: postgres
? password: ********
? database: mantis
? install loopback-connector-postgresql@^2.4 Yes

Conﬁgure model
$ lb model
? Enter the model name: dive
? Select the data-source to attach dive to:
postgres-db
? Select model’s base class PersistedModel
? Expose dive via the REST API? Yes
? Custom plural form (used to build REST URL):
dives
? Common model or server only? common
Let’s add some dive properties now.

Conﬁgure model properties
Enter an empty property name when done.
? Property name: id
invoke loopback:property
? Property type: number
? Required? Yes
? Default value [leave empty for none]:

Link models
$ lb relation
? Name of the model to create the relationship
from: dive
? Relation type: has many
? Name of the model to create a relationship with:
participant
? Name for the relation: participants
? Custom foreign key: dive id
? Whether a "through" model is required? No

Existing methods
Every model:
create
find
findOne
findById
updateAll
createUpdates
destroyAll
...

Remote method
Dive. divesByCountry = function (country , cb) {
var Location = app.models.location;
Location.find ({ fields: ["id"], where: {location: country }}, function (err ,
locations) {
var locationIds = [];
for (var i = 0, length = locations.length; i < length; i++) {
locationIds.push(locations[i].id);
}
Dive.find ({ where: { location_id : {"inq": locationIds }}}, cb);
})
};
Dive. remoteMethod (’divesByCountry ’, {
accepts: {arg: ’country ’, type: ’string ’},
returns: {arg: ’dives ’, type: ’Dive []’},
description: ’List the dives that are organized in a specific country ’,
http: {verb: ’get’}
});

Access control
$ lb acl
Built-in, using authentication tokens
Security per method or end-point
*, READ, WRITE, EXECUTE
DENY, ALLOW
$everyone, $authenticated, $unauthenticated, $owner

Start API server
$ node .
In debugging mode:
$ DEBUG=loopback:connector:postgresql node .

Query data
Use the built-in explorer: http://localhost:3000/explorer

Filter
ﬁelds
where
include
order
oﬀset
limit

Query data - Request

Query data - Response

Further reading
Boot scripts
Input validation
Changes to core code needed for geographic support

IBM API Connect
– Betalend
www-03.ibm.com/software/products/en/api-connect

Conclusion
+ Easy to configure and use
+ Different database types supported
+ Highly configurable
+ Good and useful documentation with examples
+ Input validation
– No native geographic support (code changes)

The End
Questions ?
All code and presentation:
https://github.com/ndsmyter/loopback-brownbag
Nicolas.DeSmyter@esfds.com

Standardized API Development using Node.js

More Related Content

What's hot (20)

Similar to Standardized API Development using Node.js (20)

Recently uploaded (20)

Standardized API Development using Node.js