Koa-rester NPM

koa-rester

npm.io

Koa based framework for deploying RESTful APIs easily

One line to deploy a REST API from a Model
Tested with mongoose and ORM models
Tested with koa-router but it should work with almost any router that provides get|post|put|delete operations.
Tested with koa-bodyparser
Todo features are listed in #1

Installation

$ npm install koa-rester

Usage

const router = new Router();
const base = 'test';

router.use(bodyParser());
rester = new Rester({ router, base });

// Expose GET, POST /test/resource 
//        GET, PATCH, DELETE /test/resource/:id
rester.add(model, 'resource').rest({
  after: async (ctx, next) => {},
  // afterPost overwrites after for POST requests
  afterPost: async (ctx, next) => {},
});

// Expose GET /test/resource1 
//        GET /test/resource1/:id
rester.add(model1, 'resource1').list({
  before: async (ctx, next) => {},
}).get();

new Koa()
  .use(r.routes())
  .use(r.allowedMethods())
  .listen(30001);

More complex examples, with model definitions included, are located in the wiki.

API Reference

koa-rester

koa-rester
- Rester ⏏
  - new Rester(options)
  - instance
    - .add(model, name) ⇒ Rester
    - .rest(options) ⇒ Rester
    - .list(options) ⇒ Rester
    - .post(options) ⇒ Rester
    - .get(options) ⇒ Rester
    - .patch(options) ⇒ Rester
    - .delete(options) ⇒ Rester
  - static
    - .errorHandler(error) ⇒ Object

Rester ⏏

Kind: Exported class

new Rester(options)

Create a new Rester.

Param	Type	Description
options	Object	Configuration object. Property router is compulsory.
options.errorHandler	function	A function that receive the DB error and returns an JSON object with at least two properties status and message. Status will be the HTTP response status and the whole object will be sent as body.
options.router	Object	The koa express style router. Any router that supports get, post, put, patch and delete operations.
options.model	Object	The persistence layer model. It can be included here or by using the add() function. Use add function if the rester itself is going to be used to export multiple resources.
options.base	String	The resource base url. It can be included here or by using the add() function. Use add function if the rester itself is going to be used to export multiple resources.
options.before	function	A koa middleware to be executed before each single rest request. It can be added in get, post, put, delete, list and rest options.
options.after	function	A koa middleware to be executed after each single rest request. It can be added in get, post, put, delete, list and rest options.

rester.add(model, name) ⇒ Rester

Kind: instance method of Rester
Returns: Rester - A new Rester instance configured with the given model and base.

Param	Type	Description
model	Object	The persistence layer Model object.
name	String	The resource name used to build the resource URI