Models

To use Neatsio, you have to create Models using Sequelize or Mongoose. Planned for the next project iterations, Neatsio will be interoperable with TypeORM, Bookshelf or Objection.js (for example).

A model is defined by its attributes & relations with others models. Neatsio help you to expose your models on your API without wasting time on configuration.

To create or instantiate your first model, please refer to the documentation of the selected ORM.

Connect model to Neatsio

A simple call is needed:

const User = require('./models/user')

neatsio.registerModel(User)

// Apply router after register models
app.use('/', neatsio.routes)

And endpoints are automatically created.

Configuration

Example:

const userOptions = {
  // {optional} Apply custom routes (see doc)
  routes: [],

  // {optional} Apply middlewares to each type of endpoint, all are optional
  middlewares: {
    before: [(req, res, next) => { next() }, ...],
    after: [(req, res, next) => { next() }, ...],
    getOne: [(req, res, next) => { next() }, ...],
    getMany: [(req, res, next) => { next() }, ...],
    createOne: [(req, res, next) => { next() }, ...],
    createBulk: [(req, res, next) => { next() }, ...],
    updateOne: [(req, res, next) => { next() }, ...],
    updateDelete: [(req, res, next) => { next() }, ...]
  },

  // {optional} Remove fields from response returning entity/entities
  hiddenAttributes: ['lastTimePasswordChanged']
}

const User = require('./models/user')

neatsio.registerModel(User, userOptions)

app.use('/', neatsio.routes)