Sequelize Router 😎

An easy to use, RESTful route generator designed to work with Sequelize.

Why use Sequelize Router?

• It's tiny (2kb unminified)

• It's easy to use! You can get up and running in about a minute with almost zero configuration.

• It's customizable and extensible. Easily override any of the default route controllers.

Installation

Available on npm:

npm install sequelize-router

Prerequisites

• sequelize-router is middleware that runs on top of sequelize, a popular ORM for node.js applications. Therefore, make sure that you have configured a database prior to use.

• (Optional) Consider using sequelize-cli to quickly scaffold models of your database to be used for even quicker deployement:

$ npm install --save-dev sequelize-cli
$ npm install --save sequelize
$ sequelize init:config init:models

Usage

var express = require('express');
// Require the sequelize-router middleware and any models to be used
var sequelizeRouter = require('sequelize-router');
var db = require('./models');
 
var app = express();
// Use the sequelize-router middleware as shown below
app.use('/api', sequelizeRouter(db.Inventory)); 
app.use('/api', sequelizeRouter(db.Store));
app.use('/api', sequelizeRouter(db.Transaction));

That's literally it. 💥 Restful API Routes are now created for three models.

• In the example above, RESTful API routes are being created for the Inventory, Store and Transaction models. Model names are lowercased and used to construct endpoints.

API Documentation

## Defaults

• By default, each endpoint responds with the data retrieved from the Sequelize query, or from the error returned.

• Defaults are can be easily overridden for any model's methods by passing a configuration object into the sequelize-router middleware. Further documentation on this to come.

## Authors

Christian Eckenrode

## Contributors

• Alan Chu

• Ray McCann