express-pro-crud v1.0.4

express-pro-crud

A library for building crud with express and mongo.

const mongoose = require('mongoose');
const express = require('express');
const { crud } = require('express-pro-crud');

const {
    Schema
} = mongoose;

const app = express();

const PORT = 3333;

const bestEntitySchema = new Schema({
    name: String,
    updatedAt: Date,
    deletedAt: Date
});

const bestEntityCrud = crud({
    entityName: 'bestEntity',
    mongo: {
        schema: bestEntitySchema
    }
});

app.use(bestEntityCrud)

Contracts

• add antity POST => /{entityName}
• update entity PUT => /{entityName}?id=${id} or id in body
• delete entity DELETE => /{entityName}?id=${id} or id in body
• getAll entity instances GET => /{entityName}
• get entity by id GET => /{entityName}/{id}

Response Contracts

{
  "status": true,
  "error": null,
  "content": [
    {
      "_id": "611545e14308db2225ab5399",
      "name": "best entity 2",
      "__v": 0
    },
    {
      "_id": "6118114d8005f92d5df8632f",
      "name": "best entity",
      "__v": 0,
      "updatedAt": "2021-08-14T18:58:48.001Z"
    }
  ]
}

error response

{
  "status": false,
  "error": {
    "status": 400,
    "msg": "Could not make this operation",
    "reason": "Validation Error",
    "url": "/bestEntity?id=611544f3a835c720daad309d",
    "ip": "::ffff:127.0.0.1",
    "validationErrors": [
      {
        "field": "name",
        "msg": "name cant be blank"
      }
    ]
  },
  "content": null
}

api prefix

you can add an API prefix for each entity just by adding apiPrefix value

const bestEntityCrud = crud({
    entityName: 'bestEntity',
    mongo: {
        schema: bestEntitySchema
    },
    apiPrefix: '/api'
});

in this case the expected path will be /api/bestEntity

disable logs

const bestEntityCrud = crud({
    entityName: 'bestEntity',
    mongo: {
        schema: bestEntitySchema
    },
    apiPrefix: '/api',
    disableLogs: true
});

in this case the system logs will not be fired