Giter VIP home page Giter VIP logo

crudtacular's Introduction

About

Crudtacular is a Hapi plugin that automatically bridges all the Model/Collection Bookshelf logic that a developer usually has to write in custom handlers.

With Crudtacular, you define crudtacular as the handler itself in your route definitions and simple CRUD routes are ready to go without additional setup.

NPM Installation

npm install --save crudtacular

Hapi Plugin Integration

When defining your Hapi plugins, require the following file and add it to the array of plugins that Hapi should use.

server.register({
  register : require('crudtacular'),
}, function(err) {
  if (err) throw err;
});

Examples

From any of your Hapi routes, you can define the following handler

const handler = {
  crudtacular : {
    pathPrefix : '/api',
    model : User.Model,
    collection : User.Collection,
  },
};

From there, in your individual route definitions, use the new handler. You can include pre functions, if desired, to supplement query parameters or check that the user has the correct permissions to actually call the function.

server.route({
  path : `/api/users`,
  method : 'GET',
  handler : handler,
  config : {
    description : 'Fetch all users',
  },
});

server.route({
  path : `/api/users/{userId}`,
  method : 'GET',
  handler : handler,
  config : {
    description : 'Fetch user',
  },
});

server.route({
  path : `/api/users`,
  method : 'POST',
  handler : handler,
  config : {
    description : 'Add new user',
  },
});

server.route({
  path : `/api/users/{userId}`,
  method : 'UPDATE',
  handler : handler,
  config : {
    pre : [
      canUpdateUser,
    ],
    description : 'Update user if an admin or the user is himself',
  },
});

server.route({
  path : `/api/users/{userId}`,
  method : 'DELETE',
  handler : handler,
  config : {
    pre : [
      canDeleteUser,
    ],
    description : 'Delete user if an admin or the user is himself',
  },
});

crudtacular's People

Contributors

bjyoungblood avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

jwdotjs

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.