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).

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

npm i -S netiam

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

• Authentication (with passportjs and OAuth 2.0)
• Authorization (through ACLs)
• Relationships(on resource level)
• Query language (OData filter expressions)
• 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

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)

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

const path = api()
  .rest({…})
  .json()

app.get('/foo', path)

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

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

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.

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

npm test

• Polycular
• AWS

MIT License