Apiato NPM | npm.io

APIATO.JS

Creating a rest API with Mongoose and ExpressJS has never been easier.

Thanks to APIATO you can create a REST API or a microservice for your projects in minutes and with a lot of features, in the easiest way you can imagine.

APIATO is a helper that allows you from the ExpressJS router to create a basic CRUD based on standardized HTTP requests.

It has the main operations of a CRUD, but enhanced to the maximum, offering the possibility of strengthening your query from the use of parameters and searches from the client.

APIATO can be easily integrated with ExpressJS. to be used in monolithic projects, microservices, or to be consumed through a gateway.

In APIATO you can use any of the following functions independently or simultaneously.

POST: createOne (The way to create a new item in a collection)
POST: createMany (The way to create multiple items in a collection)
GET: getMany (Get multiple items from a collection)
GET: getOneById (Get an item from the collection by ID)
GET: getOneWhere (Get an item from the collection through a search)
PUT: findUpdateOrCreate (Find an element, and edit it; In case of not finding it, create the new element in the collection)
PUT: findUpdate (Find an item and edit it in a collection)
PUT: updateById (Find an item by ID and edit it)
DELETE: findIdAndDelete (Find an item by ID and delete it)
POST: datatable (support for mongoose-datatables-fork plugin)
POST: datatable_aggregate (Call data from aggregation and returns to datatable format)

And this is not all within those functions and through parameters that can be sent mainly in the query of the URL you can.

Populate one or more fields
Select the fields you want to return only
Paginate an item
Apply filters and searches (by objectID, value, and% LIKE%)
Sort items and much more.

How to use

Configure ExpressJS basic project

const express = require("express");
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.urlencoded({extended: true}));
app.use(bodyParser.json());

app.get('/', function (req, res) {
    res.status(200).json({isAlive: true})
})

app.listen(3000, () => {
    console.log("The server started at port 3000");
});

Add mongoose configuration and connect database

const mongoose = require("mongoose");
const Schema = mongoose.Schema;

var uri = "mongodb://localhost:27017/apiator";
mongoose.connect(uri, {useUnifiedTopology: true, useNewUrlParser: true});
const connection = mongoose.connection;
connection.once("open", function () {
    console.log("MongoDB database connection established successfully");
});

Create your first model, and schema

let employee = new Schema(
    {
        name: {
            type: String
        },
        age: {
            type: Number
        },
        location: {
            type: String
        }
    }
);
let employeeModel = mongoose.model("employees", employee);

let employeeValidationObject = {
    name: 'string,mandatory',
    age: 'number,mandatory',
    location: 'string'
}

Install APIATO

npm install apiato

Install and initialize APIATO

//import APIATO
let apiato = require('apiato')
//initialize microservice objecto for employee colection
let ms_employee = new apiato();

Define routing using APIATO

//Populate object configuration
let populationObjectEmployee = false
//Options object configuration
let optionsEmployee = {}

// routes definition using express and APIATO

let aggregate_pipeline = []


app.post('/api/employee', ms_employee.createOne(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.post('/api/employee/many', ms_employee.createMany(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))

app.get('/api/employee/one', ms_employee.getOneWhere(employeeModel, populationObjectEmployee, optionsEmployee))
app.get('/api/employee/:id', ms_employee.getOneById(employeeModel, populationObjectEmployee, optionsEmployee))
app.get('/api/employee', ms_employee.getMany(employeeModel, populationObjectEmployee, optionsEmployee))

app.put('/api/employee/find_update_or_create', ms_employee.findUpdateOrCreate(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.put('/api/employee/find_where_and_update', ms_employee.findUpdate(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.put('/api/employee/:id', ms_employee.updateById(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))

app.delete('/api/employee/:id', ms_employee.findIdAndDelete(employeeModel, optionsEmployee))

app.post('/api/employee/datatble', ms_employee.datatable(employeeModel, populationObjectEmployee, ''))
app.post('/api/employee/dt_agr', ms_employee.datatable_aggregate(employeeModel, aggregate_pipeline, ''))

Full example code

const express = require("express");
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.urlencoded({extended: true}));
app.use(bodyParser.json());
const mongoose = require("mongoose");

var uri = "mongodb://localhost:27017/apiator";
mongoose.connect(uri, {useUnifiedTopology: true, useNewUrlParser: true});
const connection = mongoose.connection;
connection.once("open", function () {
    console.log("MongoDB database connection established successfully");
});
let apiato = require('apiato')
let ms_employee = new apiato();
const Schema = mongoose.Schema;
let employee = new Schema(
    {
        name: {
            type: String
        },
        age: {
            type: Number
        },
        location: {
            type: String
        }
    }
);
let employeeModel = mongoose.model("employees", employee);

let employeeValidationObject = {
    name: 'string,mandatory',
    age: 'number,mandatory',
    location: 'string'
}

let populationObjectEmployee = false
let optionsEmployee = {}

app.get('/', function (req, res) {
    res.status(200).json({ok: 'ok'})
})

let aggregate_pipeline = []

app.post('/api/employee', ms_employee.createOne(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.post('/api/employee/many', ms_employee.createMany(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.get('/api/employee/one', ms_employee.getOneWhere(employeeModel, populationObjectEmployee, optionsEmployee))
app.get('/api/employee/:id', ms_employee.getOneById(employeeModel, populationObjectEmployee, optionsEmployee))
app.get('/api/employee', ms_employee.getMany(employeeModel, populationObjectEmployee, optionsEmployee))
app.put('/api/employee/find_update_or_create', ms_employee.findUpdateOrCreate(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.put('/api/employee/find_where_and_update', ms_employee.findUpdate(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.put('/api/employee/:id', ms_employee.updateById(employeeModel, employeeValidationObject, populationObjectEmployee, optionsEmployee))
app.delete('/api/employee/:id', ms_employee.findIdAndDelete(employeeModel, optionsEmployee))
app.post('/api/employee/datatble', ms_employee.datatable(employeeModel, populationObjectEmployee, ''))
app.post('/api/employee/dt_agr', ms_employee.datatable_aggregate(employeeModel, aggregate_pipeline, ''))
app.get('/api/employee/aggregate', ms_employee.aggregate(employeeModel, aggregate_pipeline))

app.listen(3000, () => {
    console.log("El servidor está inicializado en el puerto 3000");
});

Full example code NOW FOR SQL

/*imports*/
const {Sequelize, DataTypes} = require("sequelize");
const sequelize = new Sequelize({
    dialect: 'sqlite',
    storage: './database.sqlite',
    //logging: console.log,
});

const {UUIDV4} = require('sequelize');
const moment = require('moment');

/* Define model */
const User = sequelize.define('User', {
    _id: {
        type: DataTypes.UUID,
        defaultValue: UUIDV4,
        allowNull: false,
        primaryKey: true,
        field: '_id',
    },
    password: {
        type: DataTypes.STRING,
        allowNull: true,
        field: 'password',
        customName: 'Password',
        isPassword: true
    },
    username: {
        type: DataTypes.STRING,
        allowNull: false,
        defaultValue: '',
        field: 'username',
        customName: 'Username',

    },
    type_user: {
        type: DataTypes.ENUM('admin', 'client'),
        allowNull: false,
        defaultValue: 'client',
        field: 'type_user',
        customName: 'Type of user',
    },
    name: {
        type: DataTypes.STRING,
        allowNull: true,
        defaultValue: '',
        field: 'name',
        customName: 'Name',
    },
    lastname: {
        type: DataTypes.STRING,
        allowNull: true,
        defaultValue: '',
        field: 'lastname',
        customName: 'Last name',
    },
    email: {
        type: DataTypes.STRING,
        allowNull: true,
        defaultValue: '',
        field: 'email',
        customName: 'Email',
    },
    picture: {
        type: DataTypes.STRING,
        allowNull: true,
        defaultValue: false,
        field: 'picture',
        customName: 'Photo',
        isFile: true
    },
    cellphone: {
        type: DataTypes.STRING,
        allowNull: true,
        field: 'cellphone',
        customName: 'Cellphone',
    },
    birthdate: {
        type: DataTypes.DATE,
        allowNull: true,
        field: 'birthdate',
        get() {
            const rawValue = this.getDataValue('birthdate');
            return moment(rawValue).format('YYYY-MM-DD');
        }, customName: 'Date of birth',
    },
    active: {
        type: DataTypes.BOOLEAN,
        allowNull: false,
        defaultValue: true,
        field: 'active',
        customName: 'Active',
    },
    isBanned: {
        type: DataTypes.BOOLEAN,
        allowNull: false,
        defaultValue: false,
        field: 'isBanned',
        customName: 'Is banned',
    },
}, {
    tableName: 'users',
    timestamps: true,
});

console.log('* * * ** * * * MODELO ', User.name, User.rawAttributes)

/* Sync model */
User.sync({alter: true});


let apiato_sql = require('apiato/sql')


const express = require('express')
const app = express()
const port = 3000

const bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({extended: false}));

// parse application/json
app.use(bodyParser.json());

let validationObject = {
    username: 'mandatory'
}
let populationObject = {}
let options = {}

let main = async function () {
    try {
        await sequelize.authenticate();
        console.log('Connection has been established successfully.');
    } catch (error) {
        console.error('Unable to connect to the database:', error);
    }

    /* For betther results configure models to accept as priary key _id =UUID  */
    let apiato = new apiato_sql('_id') /* the name of id for your table or model default _id */


    app.get('/', (req, res) => {
        res.send('Hello World!')
    })

    app.post('/api/user/datatable', apiato.datatable_aggregate(User, populationObject, ''))

    app.post('/api/user', apiato.createOne(User, validationObject, populationObject, options))
    app.post('/api/user/many', apiato.createMany(User, validationObject, populationObject, options))


    app.get('/api/user/aggregate', apiato.aggregate(User, {}, options))


    app.get('/api/user/one', apiato.getOneWhere(User, populationObject, options))
    app.get('/api/user/', apiato.getMany(User, populationObject, options))
    app.get('/api/user/:id', apiato.getOneById(User, populationObject, options))


    app.put('/api/user/findUpdateOrCreate', apiato.findUpdateOrCreate(User, validationObject, populationObject, options))
    app.put('/api/user/findUpdate', apiato.findUpdate(User, validationObject, populationObject, options))
    app.put('/api/user/:id', apiato.updateById(User, validationObject, populationObject, options))
    app.delete('/api/user/:id', apiato.findIdAndDelete(User, options))


    app.listen(port, () => {
        console.log(`Example app listening on port ${port}`)
    })

}

main()

Methods

*POST:createOne (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
validation(Object): optional Object that helps you to validate body object request
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

body(Object): The object will be stored in collection
query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format

Fetch request example

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "name": "Erlich Bachman",
    "age": 38,
    "location": "Palo Alto C.A."
});

var requestOptions = {
    method: 'POST',
    headers: myHeaders,
    body: raw,
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/?select[name]=1&select[age]=1", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e14341b17c7b17a388e5a5",
    "name": "Erlich Bachman",
    "age": 38
  }
}

*POST:createMany (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
validation(Object): optional Object that helps you to validate body object request
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

body(Object): The array of objects will be stored in collection
query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format

Fetch request example

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify([{
    "name": "Erlich Bachman",
    "age": 38,
    "location": "Palo Alto C.A."
}, {
    "name": "Dinesh",
    "age": 28,
    "location": "Palo Alto C.A."
}]);

var requestOptions = {
    method: 'POST',
    headers: myHeaders,
    body: raw,
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/?select[name]=1&select[age]=1", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": [
    {
      "name": "Erlich Bachman",
      "age": 38,
      "location": "Palo Alto C.A."
    },
    {
      "name": "Dinesh",
      "age": 28,
      "location": "Palo Alto C.A."
    }
  ]
}

*GET:getMany (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format
- sort(Object):Object that defines the fields will be used for order results 'DESC' for descending or 'ASC' ascending
- paginate(Object):Object with 2 properties 'page' and limit, defines the number of results to return and page
- where(Object):Object filter to exactly match in find query for values
- whereObject(Object):Object filter to exactly match in find query for mongoose objectIDs
- like(Object):Object filter to regex match in find query for values %LIKE% equivalent

Fetch request example

var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/?paginate[page]=2&paginate[limit]=3&sort[name]=ASC&select[name]=1", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": [
    {
      "_id": "60e0f5ef37eb110f8c2b5768",
      "name": "Dinesh Chugtai"
    },
    {
      "_id": "60e0f63a6d6d6e0f8f016e11",
      "name": "Dinesh Chugtai"
    },
    {
      "_id": "60e0f6c5435a9b0f904c347b",
      "name": "Dinesh Chugtai"
    }
  ]
}

*GET:getOneWhere (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format
- sort(Object):Object that defines the fields will be used for order results 'DESC' for descending or 'ASC' ascending
- where(Object):Object filter to exactly match in find query for values
- whereObject(Object):Object filter to exactly match in find query for mongoose objectIDs
- like(Object):Object filter to regex match in find query for values %LIKE% equivalent

Fetch request example

var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/one?like[name]=Jared", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e0f6c5435a9b0f904c347c",
    "name": "Donald 'Jared' Dunn",
    "age": 24,
    "location": "Palo Alto C.A.",
    "__v": 0
  }
}

*GET:getOneById (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format

Fetch request example

var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/60e0f5ef37eb110f8c2b5768", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e0f5ef37eb110f8c2b5768",
    "name": "Dinesh Chugtai",
    "age": 24,
    "location": "Palo Alto C.A.",
    "__v": 0
  }
}

*PUT:findUpdateOrCreate (mongodb/SQL)

(Updates only first appearance by match, not updates many elements )

Method Parameters

model(mongoose class):mandatory The moongose model object
validation(Object): optional Object that helps you to validate body object request
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format
- where(Object):Object filter to exactly match in find query for values
- whereObject(Object):Object filter to exactly match in find query for mongoose objectIDs

Fetch request example

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "name": "Erlich Bachmanity",
    "age": 40,
    "location": "Palo Alto C.A."
});

var requestOptions = {
    method: 'PUT',
    headers: myHeaders,
    body: raw,
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/find_update_or_create?where[name]=Erlich Bachmanity", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachmanity",
    "age": 40,
    "location": "Palo Alto C.A.",
    "__v": 0
  }
}

*PUT:findUpdate (mongodb/SQL)

(Updates only first appearance by match, not updates many elements )

Method Parameters

model(mongoose class):mandatory The moongose model object
validation(Object): optional Object that helps you to validate body object request
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format
- where(Object):Object filter to exactly match in find query for values
- whereObject(Object):Object filter to exactly match in find query for mongoose objectIDs
- like(Object):Object filter to regex match in find query for values %LIKE% equivalent

Fetch request example

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "name": "Erlich BachmanityX",
    "age": 40,
    "location": "Palo Alto C.A."
});

var requestOptions = {
    method: 'PUT',
    headers: myHeaders,
    body: raw,
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/find_where_and_update?where[name]=Erlich Bachmanity", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich BachmanityX",
    "age": 40,
    "location": "Palo Alto C.A.",
    "__v": 0
  }
}

*PUT:updateById (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
validation(Object): optional Object that helps you to validate body object request
population(Objet):optional Object that defines wich fields you can populate and its related model
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- populate(Object): Object that defines parameters will return populated
- select(Object):Object that defines wich parameters return. Object must be transformed to url format

Fetch request example

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX"
});

var requestOptions = {
    method: 'PUT',
    headers: myHeaders,
    body: raw,
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/60e243c82b4d320571d00639", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX",
    "__v": 0
  }
}

*DELETE:findIdAndDelete (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
options(Object): optional Object that defines some configuration for mongoose and elements requested
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

Fetch request example

var requestOptions = {
    method: 'DELETE',
    redirect: 'follow'
};

fetch("http://localhost:3000/api/employee/60e243c82b4d320571d00639", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX",
    "__v": 0
  }
}

*POST:datatable_aggregate (mongodb/SQL)

Method Parameters

model(mongoose class):mandatory The moongose model object
pipeline(agreggation pipeline):optional The mongodb pipeline aggregation
search_fields (columns where datatble find):optional Array of search fields
options(Object): optional Object that defines some configuration for mongoose and elements requested ( allowDiskUsage:default=true search_by_field:default=false )
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

Fetch request example

var requestOptions = {
    method: 'POST',
};

fetch("http://localhost:3000/api/datatable", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX",
    "__v": 0
  }
}

*GET:aggregate (mongodb/SQL = for SQL adds a custom sequelize object )

Method Parameters

model(mongoose class):mandatory The moongose model object
pipeline(agreggation pipeline):optional The mongodb pipeline aggregation
options(Object): optional Object that defines some configuration for mongoose and elements requested ( allowDiskUsage:default=true )
fIn_(function): optional Async function that can be executed before process recieve and must to return Express 'res' object.
fMid_(function): optional Async function that can be executed after create all pipeline of agreggation and before execute 'aggregation exec' object.
fOut_(function): optional Async function that can be executed after process recieve and must to return mongoose query result.

Request Parameters

query(url): Could contain the next elements
- where(object):find where in a match
- where(object):find where in a match if is a objectID
- like(object):find where in a regular expression
- paginate(object):page: number of page, limit: how many items per page
- sort(object): the order asc or desc of an element
- select(Object):Object that defines wich parameters return. Object must be transformed to url format

Fetch request example

var requestOptions = {
    method: 'POST',
};

fetch("http://localhost:3000/api/aggregate", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Example fetch response

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX",
    "__v": 0
  }
}

Responses example

Success

{
  "error": {},
  "success": true,
  "message": "ok",
  "code": 200,
  "data": {
    "_id": "60e243c82b4d320571d00639",
    "name": "Erlich Bachman!!",
    "age": 50,
    "location": "Huston TX",
    "__v": 0
  }
}

Error

{
  "error": "404 not found",
  "success": false,
  "message": "404 not found",
  "code": 404,
  "data": {}
}

Object methods example

Options

let options = {
    "customValidationCode": 450, //default 435
    "customErrorCode": 600, //default 500
    "customNotFoundCode": 420, //default 404
    "mongooseOptions": {}, //bypass mongoose options

}

Population Object (mongodb/SQL)

let populationObject = {
    user: userModel // defines the path and mongoose model -> Path:user, Model: userModel
}

Validation Object (mongodb/SQL)

let validationObject = {
    name: 'string,mandatory',
    age: 'number,mandatory',
    regDate: 'date',
}

Object request query URL example (mongodb/SQL)

where

?where[name]=erick&where[age]=30

equal to

let where = {
    name: 'erick',
    age: 30
}

whereObject

?where[user_id]=60e243c82b4d320571d00639

equal to

let whereObject = {
    user_id: ObjectId('60e243c82b4d320571d00639'),
}

like

?like[name]=eri

equal to

let like = {
    name: {$regex: 'eri', $options: 'i'},
}

paginate

?paginate[page]=1&paginate[limit]=10

equal to

let paginate = {
    page: 1,
    limit: 10
}

sort

?sort[name]=DESC&sort[age]=ASC

equal to

let sort = {
    name: "DESC",
    age: "ASC"
}

select

?select[name]=1&select[age]=1&select[location]=0

equal to

let select = {
    name: 1,
    age: 1,
    location: 0,
}

populate

?populate[class]=1&populate[king]=1&populate[users]=0

equal to

let populate = {
    class: 1,
    kind: 1,
    users: 0,
}

CRUD API REST AVIATO PiedPiper Microservices Mongoose express datatables

moment mongoose sequelize

@everything-registry/sub-chunk-1151 slice-line tres-comas apied-piper endframe-functions @zalastax/nolb-apia

2 months ago

6 months ago

7 months ago

7 months ago

7 months ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago