princess-barkles-rest-api v2.8.8

A generator for REST API's

Generates simple REST API applications using an incredibly simple schema/api config. Apologies for the very rushed examples below but I will look to improve the documentation as soon as possible!

There are currently 2 very early datasource implementations for this framework:

• princess-barkles-datasource-memory (I only use this locally for testing).
• princess-barkles-datasource-mongodb (In use in production).

There is 1 request logging implementation that is based on bunyan:

• princess-barkles-request-logger-bunyan. Will update the docs for this but it effectively logs each incoming request, each outgoing response and errors that are raised. It is very early but when customising the business logic (see Creating a REST API with some simple business logic) then req.log is a bunyan instance that can be used.

Creating a simple REST API.

server.js

const datasource = require('princess-barkles-datasource-memory')();
const app = require('../src/princess-barkles-rest-api')({
	datasourceInstance: datasource,
	resources: {
		greeting: {}
	}});
app.listen(process.env.PORT);

Creating a REST API with some simple business logic

server.js

const datasource = require('princess-barkles-datasource-memory')();
const app = require('../src/princess-barkles-rest-api')({
	datasourceInstance: datasource,
	resources: {
		greeting: {
		    create: {
                before:[
                    (req, res, next) => {
                        console.log('Running a before hook');
                        next();
                    }
                ],
                after:[
                    (req, res, next) => {
                        console.log('Running an after hook');
                        next();
                    }
                ]
            },
		    read: {
		        before:[
		            (req, res, next) => {
		                console.log('Running a before hook');
		                next();
		            }
		        ],
		        after:[
                    (req, res, next) => {
                        console.log('Running an after hook');
                        next();
                    }
                ]
		    },
		    readById: {
                before:[
                    (req, res, next) => {
                        console.log('Running a before hook');
                        next();
                    }
                ],
                after:[
                    (req, res, next) => {
                        console.log('Running an after hook');
                        next();
                    }
                ]
            },
            updateById: {
                before:[
                    (req, res, next) => {
                        console.log('Running a before hook');
                        next();
                    }
                ],
                after:[
                    (req, res, next) => {
                        console.log('Running an after hook');
                        next();
                    }
                ]
            },
            delete: {
                before:[
                    (req, res, next) => {
                        console.log('Running a before hook');
                        next();
                    }
                ],
                after:[
                    (req, res, next) => {
                        console.log('Running an after hook');
                        next();
                    }
                ]
            }
		}
	}});
app.listen(process.env.PORT);

Creating a REST API with api key authentication.

server.js

const datasource = require('princess-barkles-datasource-memory')();
const app = require('../src/princess-barkles-rest-api')({
	authentication: {
	    apiKey: '1234567890' // Requires header to be sent 'apikey=1234567890'
	},
	datasourceInstance: datasource,
	resources: {
		greeting: {}
	}});
app.listen(process.env.PORT);