akh-mongo-connect v1.0.1

##List of features It provides the connectivity with the mongoDB and expose the endpoints to perform the CRUD operation on the colletions

##Download & Installation

$ npm i akh-mongo-connect

##Guide After installing you need to use the package as below mentioned.

const express = require('express');

// Configuring the database
const config = require('./config.js');

// create express app
let app = express();

app = require('akh-mongo-connect')(app, config);
// listen for requests
app.listen(3000, () => {
    console.log("Server is listening on port 3000");
});

Config file format should be as mentioned below

module.exports = {
    DBurl: 'mongodb://db_host_with_port/db_name',
    allowedHost: '<Any url which need to be open for CORS>',
    accessKey: '<Specify the complex security key>'
}

After installing and configuring, you would be able to access the crud APIs for the collections. Below mentioned is the detail for the APIs

###Add Data to Collection

curl -X POST \
  http://<HOSTNAME>/api-console/<Collection Name> \
  -H 'content-type: application/json' \
  -H 'x-accesskey: <key_specified_in_cinfig.js>' \
  -d '{
	"firstName": "John",
	"lastName": "Doe"
}'

###Update data in collection

curl -X PUT \
  http://<HOSTNAME>/api-console/<Collection Name>/<DocumentID> \
  -H 'content-type: application/json' \
  -H 'x-accesskey: <key_specified_in_cinfig.js>' \
  -d '{
	"firstName": "John",
	"lastName": "Doe"
    "address": {
        "street": "Stree1"
    }
}'

###List of the data in collection

curl -X GET \
  'http://<HOSTNAME>/api-console/<Collection Name>' \
  -H 'content-type: application/json' \
  -H 'x-accesskey: <key_specified_in_cinfig.js>' \

###Get single document in collection by ID

curl -X GET \
  'http://<HOSTNAME>/api-console/<Collection Name>/<DocumentID>' \
  -H 'content-type: application/json' \
  -H 'x-accesskey: <key_specified_in_cinfig.js>' \

###Delete the document by Document ID

curl -X DELETE \
  http://<HOSTNAME>/api-console/<Collection Name>/<DocumentID> \
  -H 'accesskey: <key_specified_in_cinfig.js>' \
  -H 'content-type: application/x-www-form-urlencoded' \

If you need any other help, you can contact us at amu.akhlaq@gmail.com

##Author Akhlaq Ahmad

##Licence Copyright 2018

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.