amuse (ah mooz)

a super simple super opinionated nodejs microservice-friendly restful api.

amuse supports node 8.x with the harmony flag

node --harmony index.js

npm install

npm install --save amuse

examples

simple

const amuse = require('amuse');

const conn = require('conn.env');
const app = amuse();

app.connect(conn);

app.resource({ tableName: 'rooms' });

app.listen(3000);

detailed with commentary

const amuse = require('amuse');

// these are koa middlewares
const loggerMiddleware = require('./middlewares/logger');
const roomMiddleware = require('./middlewares/room/middleware');

/*
  const conn = {
    client: 'mysql',
    connection: {
      host: 'host',
      user: 'user',
      password: 'password',
      database: 'database',
      charset: 'charset',
    },
  };
*/
const conn = require('conn.env');

const app = amuse();

app.connect(conn);

// this is a bookshelf model
app.resource({ tableName: 'rooms' });

// this middleware runs on all requests
app.middlewares.add(loggerMiddleware);

/*  all middleware and validator additions return an unsubscribe function.
    if at any time you want to opt out, just call the unsub function */
const unsub = app.middleware.add(loggerMiddleware);
unsub();

// these validators happen when creating/updating a model
app.resources.rooms.validates('owner', room => room.owner);
app.resources.rooms.validates('title', room => room.title);
app.resources.rooms.validates('description', room => room.description);
app.resources.rooms.validates(
  'description',
  room => room.description.length > 10,
  'Room description must be at least 10 characters'
);

// this middleware runs on only requests to room resources
app.resources.rooms.middlewares.add(roomMiddleware);

/*
  all of these are automatically created

  GET localhost:3000/rooms/
    [{ id: 1, description: '...', title: '...'}, { id: 2, description: '...', title: '...'}]
  GET localhost:3000/rooms/1
    { id: 1, description: '...', title: '...'}
  POST localhost:3000/rooms/
  { description: '...', title: '...' }
    { id: 3, description: '...', title: '...' }
  PUT localhost:3000/rooms/3
  { id: 3, description: '---', title: '---' }
    { id: 3, description: '---', title: '---' }
  DELETE localhost:3000/rooms/3
    {}
*/
app.listen(3000);

/* the standard amuse response object is as follows
{
  "success": true,
  "errors": null,
  "data": [
      {
          "id": 2,
          "owner_id": 5,
          "description": "hello!",
          "created": "2017-07-25T07:00:00.000Z"
      },
      {
          "id": 3,
          "owner_id": 5,
          "description": "hello!!!",
          "created": "2017-07-25T07:00:00.000Z"
      },
      {
          "id": 4,
          "owner_id": 5,
          "description": "hello!!!!!!",
          "created": "2017-07-25T07:00:00.000Z"
      }
  ]
}
*/

/* amuse also handles errors in a similar way
{
    "success": false,
    "errors": [
        {
            "owner_id": [
                "Object did not pass validation for property owner_id"
            ],
            "description": [
                "Descriptions must be at least five characters long"
            ]
        }
    ],
    "data": null
}
*/

notes

you might have to add your own flavor of database connection - postgres, maria, sqlserver. just npm install it.

please don't use this in production yet. thanks a bunch