This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

netiam

A pure REST library

This REST API library addresses some issues we had with API designs in our projects. It does not claim to provide a full featured solution and to be honest, it might never will. Nevertheless, someone might find this library useful. It works as connect middleware and you should be able to use it with any compatible infrastructure (e.g. express).

TOC

• Bootstrap
• Objects
• ACL
• Dispatch Flow
• Models
• Plugins
• Resources

Get it

npm i -S netiam@7

Plugins

• Authentication
• Authorization
• REST
• Transform
• Data
• JSON
• OAuth

What can it do for you

• Authentication (with passportjs and OAuth 2.0)
• Authorization (with ACLs, inheritance support for roles, assertions and wildcards)
• Relationships(on resource level)
• Query language (effective and powerful filters with OData)
• Completely stateless (except cookie based sessions for authentication in browser apps)
• Support for the JSONAPI specification
• Auto response format detection
• Graph representation and rendering (as SVG)
• Extensible with plugins

Getting started

Creates a single route, using the data plugin to add some data and returns everything as JSON.

import express from 'express'
import http from 'http'
import api from 'netiam'
 
const app = express()
const server = http.createServer(app)
 
app.get(
  '/users'
  api()
    .data({'Hello': 'World!'})
    .json()
)
 
server.listen(3000)

How it works

The core idea of this library is to have a stack of plugins executed in an asynchronous way.

const path = api()
  .rest({…})
  .json()
 
app.get('/foo', path)

Plugin example

export default function data(data) {
  return function(req, res) {
    res.body = data;
  }
}
 

Example

app.get(
  '/users',
  api()
    .auth(…)
    .rest(…)
    .acl.res(…)
    .jsonapi({…})
)

Error handling

You do not need to handle common API errors on your own. The library responds to the client at least with a proper HTTP status code (e.g. 404 for document not found) automatically.

Tests

Using mocha with should for tests and istanbul to check coverage.

npm test

Supported by

• Polycular
• AWS

License

MIT License