restful-express-sequelize

RESTful - is easy to use restful service implementation for express and sequelize

Registers your database context on restful definitions, and service is created with it at github link.

For instance your database table is "Frameworks" in mysql registered as /frameworks for methods:

• GET /frameworks
• GET /frameworks/:id
• POST /frameworks
• PUT /frameworks/:id
• DELETE /frameworks/:id

and by passing methods args on your registeration in array ["get", "post", "put", "delete"] you are allowed to manipulate proper methods or register only your needs. P.S. ( as defaults all registered )

supports some default query options;

• for array Response:

  • select=property1,property2 (any property of model itself and some extras: id, href, createdAt, updatedAt)
  • sort=property,type (any property of model and type as 'desc' or 'asc' is default )
  • limit=number (25 is default)
  • offset=number (0 is default)

• for object Response:

  • select=property1,property2 (any property of model itself and some extras: id, href, createdAt, updatedAt)

response are wrapped as follows;

for array responses:

next or previous properties might not exists depending on context. (optionals) data property can be null or [].

{
  "code": 200,
  "message": "success",
  "data": [{ }],
  "count": 1, 
  "href": "$href", 
  "next": "$next", 
  "previous": "$previous", 
  "limit": 25,
  "offset": 0
}

for object or primitive responses:

data property can be null or {}.

{
  "code": 200,
  "message": "success",
  "data": { } 
}

How to install

with node package manager aka npm;

npm install --save restful-express-sequelize

Documentation for express or sequelize

Express or Sequelize

How to use

(PS: for database example check model)

if you prefer javascript then in your server.js or index.js file;

//imports
var express = require("express");
var bodyParser = require("body-parser");
var gzip = require("compression");
var context = require("restful-express-sequelize");
// model generted by sequelize-cli
// (sequelize model:create --name Framework --attributes name:string,lang:string)
var dbContext = require("./models");
// bind over ip and port instead of 127.0.0.1
var port = process.env.PORT || 52192;
var host = process.env.HOST || "192.168.1.100";
// express instance
var server = express();
// register body-parser middleware
server.use(bodyParser.json());
server.use(bodyParser.urlencoded({ extended: true }));
// register compression middleware
server.use(gzip({ filter: function (req, res) {
  return !req.headers["x-no-gzip"];
}}));
 
// get items from models
var models = [];
for (var property in dbContext) {
  // register as options you can add { model: xxx, methods: ["get", "post"] } 
  // methods are (optional) defaults all registered ["get", "post", "put", "delete"] 
  models.push({ model: dbContext[property] });  
}
// finally register your method(s) on base as '/v1/endpoint'
// base is (optional) context.Resource.register(server, model)
context.Resource.register(server, models, "/v1/endpoint");
// start serving
server.listen(port, host, function () {
  console.log("Server Running...");
});

if you prefer typescript then in your index.ts or server.ts file;

import * as express from "express";
import * as orm from "sequelize";
import * as bodyParser from "body-parser";
import * as gzip from "compression";
import { Request, Response } from "express";
import { Resource, ResourceOption } from "restful-express-sequelize";
import * as dbContext from "./models";
 
const port = process.env.PORT || 52192;
const host = process.env.HOST || "192.168.1.100";
 
const server = express();
 
server.use(bodyParser.json());
server.use(bodyParser.urlencoded({ extended: true }));
 
server.use(gzip({ filter: (req: Request, res: Response): boolean => {
  return !req.headers["x-no-gzip"];
}}));
 
if(dbContext.sequelize) {
  dbContext.sequelize.sync();
}
 
const models: Array<ResourceOption<{}, {}>> = [];
for(const property in dbContext) {  
  if(property !== "sequelize" && property !== "Sequelize") {
      models.push({ model: dbContext[property] }); 
  }  
}
 
Resource.register(server, models, "/v1/endpoint");
 
server.listen(port, host, () => {
  console.log("Server Running...");
});

Models

in /model folder

as Country.js

'use strict';
module.exports = function(sequelize, DataTypes) {
  var Country = sequelize.define('Country', {
    countryName: { type: DataTypes.STRING, allowNull: false }
  }, {
    classMethods: {
      associate: function(models) {
        Country.hasMany(models.City, { foreignKey: "countryId" });
        // Country.map is for api will show assosiations
        Country.map = [models.City];
      }
    }
  });
  return Country;
};

as City.js

'use strict';
module.exports = function(sequelize, DataTypes) {
  var City = sequelize.define('City', {
    cityName: { type: DataTypes.STRING, allowNull: false }
  }, {
    classMethods: {
      associate: function(models) {
        City.belongsTo(models.Country, { as: "country" });
      }
    }
  });
  return City;
};

as index.js

'use strict';
var fs        = require('fs');
var path      = require('path');
var Sequelize = require('sequelize');
var basename  = path.basename(module.filename);
var config    = require(path.join(__dirname, '../config/config.json'));
// placeholder for all
var dbContext = {};
// connect
var sequelize = new Sequelize(config.database, config.username, config.password, config.options);
// imports everything in this directory into entities and register relations later.
fs.readdirSync(__dirname)
  .filter(function(f) {
    return (f.indexOf('.') !== 0) && (f !== basename) && (f.slice(-3) === '.js');
  })
  .forEach(function(f) {
    var model = sequelize.import(path.join(__dirname, f));
    dbContext[model.name] = model;  
  });
// invoke associate methods on models
Object.keys(dbContext)
  .forEach(function(key) {
    if(dbContext[key].associate) {
      // this will invoke our relationships
      dbContext[key]associate(dbContext);
    }
  });
// sync context once
sequelize.sync();
// exports
module.exports = dbContext;

Changes

• optional port added for local projects.
• bug fix.

License

Copyright 2017 Fatih Şen and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.