Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gangstead/hapi-crud-promise
Easily create CRUD routes on a hapi server by providing a path and promises for each of the actions
https://github.com/gangstead/hapi-crud-promise
Last synced: 2 months ago
JSON representation
Easily create CRUD routes on a hapi server by providing a path and promises for each of the actions
- Host: GitHub
- URL: https://github.com/gangstead/hapi-crud-promise
- Owner: gangstead
- Created: 2016-01-19T01:28:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-25T22:48:35.000Z (almost 9 years ago)
- Last Synced: 2024-10-06T07:10:24.172Z (3 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
hapi-crud-promise [](https://travis-ci.org/gangstead/hapi-crud-promise) [](https://coveralls.io/github/gangstead/hapi-crud-promise?branch=master)
==========================
[](https://nodei.co/npm/hapi-crud-promise/) [](https://nodei.co/npm/hapi-crud-promise/)
- [Basics](#basics)
- [Simple Usage](#simple-usage)
- [Contributing](#contributing)
- [Pull Request Checklist](#pull-request-checklist)
- [FAQ](#faq)
### Basics
Reduce repetitive route setup for basic CRUD apps.
Provide one route and a 5 handlers:
```
/api/things/{thingId}
```
And get 5 routes added to your server:
```
GET /api/things
POST /api/things
GET /api/things/{thingId}
PUT /api/things/{thingId}
DELETE /api/things/{thingId}
```
### Simple Usage
```js
const Hapi = require('hapi');
const Joi = require('joi');
const hapiCrudPromise = require('../index');
const server = new Hapi.Server();
server.connection({ host: '127.0.0.1' });
hapiCrudPromise(server, {
path: '/api/things/{thingId}',
config: {
validate: {
query: { // validation only applied to GET (all)
limit: Joi.number().optional()
}
params: { // validation only applied to GET (one), DELETE, and UPDATE routes
thingId: Joi.string().required()
},
payload: Joi.object({ // validation only applied to POST and PUT route
thing: Joi.object({
name: Joi.string().required()
}).required()
})
}
},
crudRead(req) {
return knex('things')
.first()
.where({ id: req.params.thingId });
},
crudReadAll(req) {
return knex('things').limit(req.query.limit);
},
crudUpdate(req) {
return knex('things')
.update(req.payload.thing)
.where({ id: req.params.thingId })
.limit(1)
.returning('*')
.spread((thing) => ({ thing: thing }));
},
crudCreate(req) {
return knex('things')
.insert(req.payload.thing)
.returning('*')
.spread((thing) => ({ thing: thing }));
},
crudDelete(req) {
return knex('things')
.delete()
.where({ id: req.params.thingId })
.limit(1);
}
});
```
### Slightly-more-advanced Usage
If you have a long path in your route with multiple parameters the last one is special, it identifies the resource you are CRUD-ing and will only be included on validations for GET (one), DELETE, and UPDATE routes
```js
const Hapi = require('hapi');
const Joi = require('joi');
const hapiCrudPromise = require('../index');
const server = new Hapi.Server();
server.connection({ host: '127.0.0.1' });
hapiCrudPromise(server, {
path: '/api/users/{userId}/things/{thingId}',
config: {
validate: {
query: { // validation only applied to GET (all)
limit: Joi.number().optional()
}
params: {
userId: Joi.string().required(), // This and other param validations applied to all routes
thingId: Joi.string().required() // Except this one! only applied to GET (one), DELETE, and UPDATE routes
},
payload: Joi.object({ // validation only applied to POST and PUT route
thing: Joi.object({
name: Joi.string().required()
}).required()
})
}
},
crudRead(req) {
...
},
crudReadAll(req) {
...
},
crudUpdate(req) {
...
},
crudCreate(req) {
...
},
crudDelete(req) {
...
}
});
```
### Contributing
Contributors wanted. If you are looking for a way to help out browse the [Help Wanted](https://github.com/gangstead/hapi-crud-promise/labels/help%20wanted) issues and find one that looks good to you. If you have an idea to make hapi-crud-promise better submit a pull request.
#### Pull Request Checklist
Checklist for submitting a pull request:
- [ ] `npm run test` - Unit tests must pass
- [ ] New unit tests
- [ ] `npm run test-cov` - Code coverage cannot go down
- [ ] `npm run lint` - New code must have no linter errors
- [ ] Your pull request must pass CI
### FAQ
#### Isn't this like [hapi-crud](https://www.npmjs.com/package/hapi-crud)?
Yeah, but with [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)! And active. And the Github repo is still live.
#### Can't I just create a bunch of routes manually?
CRUD routes are repetitive. Write less code and go outside.