❤
npm
Sign UpSign In

sequelize-restful-extended

0.1.4 • Public • Published

sequelize-restful-extended

Build Status

A connect module based on a fork of sequelize-restful. Creates a restful API with associations from your Sequelize models and allows you to include parameters like sort, offset, limit and order. It also allows more complex operations like data range filters or include WHERE LIKE fields in SELECT operations.

It uses the Sequelize function findAndCountAll instead of findAll. Thanks to this, the basic GET request returns the total count of rows in the response. This number doesn't take account of the query parameters offset and limit. This feature makes easier to do pagination using the generated API.

Usage

var express   = require('express')
  , Sequelize = require('sequelize')
  , http      = require('http')
  , restful   = require('sequelize-restful-extended')
  , sequelize = new Sequelize('database', 'username', 'password')
  , app       = express()
 
// define all your models before the configure block
 
app.configure(function() {
  app.use(restful(sequelize, { /* options */ }))
})
 
http.createServer(app).listen(app.get('port'), function(){
  console.log("Express server listening on port " + app.get('port'))
})

Options

{
  // Parameter:   endpoint
  // Description: Define the path to the restful API.
  // Default:     '/api'
 
  endpoint: '/restful',
 
  // Parameter:   allowed
  // Description: Define which models will be exposed through the restful API
  // Default:     'new Array()' if it is an Empty array, all the models will be exposed by default
 
  allowed: new Array('Model0', 'Model1', 'Model2'),
 
  // Parameter:   extendedMode
  // Description: If it's true, all GET request uses the findAndCountAll function of Sequelize, 
  //              returning the count on the response. If it's false uses the default findAll.
  // Default:     true
 
  extendedMode: true
}

The API

GET /api

Returns a list of all declared models

$ curl http://localhost:3000/api
{
  "status": "success"
  "data": [
    {
      "name": "Tag",
      "tableName": "Tags"
    },
    {
      "name": "Image",
      "tableName": "Images"
    },
    {
      "name": "Project",
      "tableName": "Projects"
    }
  ]
}

HEAD /api/Tags

Returns a description of a declared model

$ curl -i -X HEAD http://localhost:3000/api/Tags

The result of the request is part of the response headers! The header's name is Sequelize-Admin.

{
  "status": "success",
  "data": {
    "name": "Tag",
    "tableName": "Tags",
    "attributes": {
      "title": "VARCHAR(255)",
      "id": {
        "type": "INTEGER",
        "allowNull": false,
        "primaryKey": true,
        "autoIncrement": true
      },
      "createdAt": {
        "type": "DATETIME",
        "allowNull": false
      },
      "updatedAt": {
        "type": "DATETIME",
        "allowNull": false
      },
      "ProjectId": {
        "type": "INTEGER"
      }
    }
  }
}

GET /api/Tags

Returns all Tags

$ curl http://localhost:3000/api/Tags
{
  "status": "success",
  "count": 3,
  "data": [{
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  },{
    "title": "foo2",
    "id": 2,
    "createdAt": "2013-02-10T09:48:14.000Z",
    "updatedAt": "2013-02-10T09:48:14.000Z",
    "ProjectId": 2
  },{
    "title": "foo3",
    "id": 3,
    "createdAt": "2013-02-11T09:48:14.000Z",
    "updatedAt": "2013-02-11T09:48:14.000Z",
    "ProjectId": 2
  }]
}

GET /api/Tags?sort=-title

Returns all Tags sorted by title descending

$ curl http://localhost:3000/api/Tags?sort=-title
{
  "status": "success",
  "count": 3,
  "data": [{
    "title": "foo3",
    "id": 3,
    "createdAt": "2013-02-11T09:48:14.000Z",
    "updatedAt": "2013-02-11T09:48:14.000Z",
    "ProjectId": 2
  },{
    "title": "foo2",
    "id": 2,
    "createdAt": "2013-02-10T09:48:14.000Z",
    "updatedAt": "2013-02-10T09:48:14.000Z",
    "ProjectId": 2
  },{
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  }]
}

GET /api/Tags?title=foo

Returns all Tags where title is foo

$ curl http://localhost:3000/api/Tags?title=foo
{
  "status": "success",
  "count": 1,
  "data": {
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  }
}

GET /api/Tags?title_like=foo

Returns all Tags where title is LIKE foo (in this example, all of them)

$ curl http://localhost:3000/api/Tags?title_like=foo
{
  "status": "success",
  "count": 3,
  "data": [{
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  },{
    "title": "foo2",
    "id": 2,
    "createdAt": "2013-02-10T09:48:14.000Z",
    "updatedAt": "2013-02-10T09:48:14.000Z",
    "ProjectId": 2
  },{
    "title": "foo3",
    "id": 3,
    "createdAt": "2013-02-11T09:48:14.000Z",
    "updatedAt": "2013-02-11T09:48:14.000Z",
    "ProjectId": 2
  }]
}

GET /api/Tags?limit=2

Returns the first two tags (Notice the count attribute in the response indicating the total tags)

$ curl http://localhost:3000/api/Tags?limit=2
{
  "status": "success",
  "count": 3,
  "data": [{
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  },{
    "title": "foo2",
    "id": 2,
    "createdAt": "2013-02-10T09:48:14.000Z",
    "updatedAt": "2013-02-10T09:48:14.000Z",
    "ProjectId": 2
  }]
}

GET /api/Tags?limit=2&offset=2

Returns the first two tags after a specific amount of elements (Notice the count attribute in the response indicating the total tags)

$ curl http://localhost:3000/api/Tags?limit=2&offset=2
{
  "status": "success",
  "count": 3,
  "data": {
    "title": "foo3",
    "id": 3,
    "createdAt": "2013-02-11T09:48:14.000Z",
    "updatedAt": "2013-02-11T09:48:14.000Z",
    "ProjectId": 2
  }
}

GET /api/Tags?createdAt_start=2013-02-11&createdAt_end=2013-02-12

Returns all tags created between two dates

$ curl http://localhost:3000/api/Tags?createdAt_start=2013-02-11&createdAt_end=2013-02-12
{
  "status": "success",
  "count": 1,
  "data": {
    "title": "foo3",
    "id": 3,
    "createdAt": "2013-02-11T09:48:14.000Z",
    "updatedAt": "2013-02-11T09:48:14.000Z",
    "ProjectId": 2
  }
}

GET /api/Tags/1

Returns the data of the Tag with the id 1.

$ curl http://localhost:3000/api/Tags/1
{
  "status": "success",
  "data": {
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  }
}

POST /api/Tags

Creating a new instance of a model

curl -d "title=hallo%20world" http://localhost:3000/api/Tags
{
  "status": "success",
  "data": {
    "title": "hallo world",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z"
  }
}

PUT /api/Tags/1

Updating an already existing instance of a model

curl -d "title=fnord" -X PUT http://localhost:3000/api/Tags/1

It returns the updated record

{
  "status": "success",
  "data": {
    "title": "fnord",
    "id": 1,
    "createdAt": "2013-02-14T19:52:04.000Z",
    "updatedAt": "2013-02-14T19:53:30.066Z",
    "ProjectId": 1
  }
}

DELETE /api/Tags/1

Deleting an existing instance of a model

curl -i -X DELETE http://localhost:3000/admin/api/Tags/3
{
  "status": "success",
  "data": {}
}

The API for Associations

GET /api/Projects/1/Tags

Returns all the instance of 'associated_dao_factory' associated to the instance 1 of 'dao_factory'

curl -i -X GET http://localhost:3000/admin/api/Projects/1/Tags
 
{
  "status": "success",
  "data": {
    "title": "foo",
    "id": 1,
    "createdAt": "2013-02-09T09:48:14.000Z",
    "updatedAt": "2013-02-09T09:48:14.000Z",
    "ProjectId": 1
  }
}

DELETE /api/Photo/1/Photographer

Deleting an existing association for 1:1 or N:1 association.

curl -i -X DELETE http://localhost:3000/admin/api/Photo/1/Photographer
{
  "status": "success",
  "data": {}
}

DELETE /api/Projects/1/Tags/1

Deleting an existing association between instances

curl -i -X DELETE http://localhost:3000/admin/api/Projects/1/Tags/3
{
  "status": "success",
  "data": {}
}

Readme

Keywords

none

Package Sidebar

Install

npm i sequelize-restful-extended

Repository

github.com/sequelize-restful-extended.git

Weekly Downloads

42

Version

0.1.4

License

MIT

Last publish

Collaborators

  • pjanaya
Try on RunKit
Report malware