hapi-sequelize-crud
Automatically generate a RESTful API for your models and associations
This plugin depends on hapi-sequelize
.
npm install -S hapi-sequelize-crud
Configure
Please note that you should register hapi-sequelize-crud
after defining your
associations.
// First, register hapi-sequelizeawait ; // Then, define your associationslet db = serverplugins'hapi-sequelize'db;let models = dbsequelizemodels;; // pretend this function defines our associations // Now, register hapi-sequelize-crudawait ;
Methods
- list: get all rows in a table
- get: get a single row
- scope: reference a sequelize scope
- create: create a new row
- destroy: delete a row
- destroyAll: delete all models in the table
- destroyScope: use a sequelize scope to find rows, then delete them
- update: update a row
where
queries
It's easy to restrict your requests using Sequelize's where
query option. Just pass a query parameter.
// returns only teams that have a `city` property of "windsor"// GET /team?city=windsor // results in the Sequelize query:Team
You can also do more complex queries by setting the value of a key to JSON.
// returns only teams that have a `address.city` property of "windsor"// GET /team?city={"address": "windsor"}// or// GET /team?city[address]=windsor // results in the Sequelize query:Team
include
queries
Getting related models is easy, just use a query parameter include
.
// returns all teams with their related City model// GET /teams?include=city // results in a Sequelize query:Team
If you want to get multiple related models, just pass multiple include
parameters.
// returns all teams with their related City and Uniform models// GET /teams?include[]=city&include[]=uniform // results in a Sequelize query:Team
For models that have a many-to-many relationship, you can also pass the plural version of the association.
// returns all teams with their related City and Uniform models// GET /teams?include=players // results in a Sequelize query:Team
limit
and offset
queries
Restricting list (GET
) and scope queries to a restricted count can be done by passing limit=<number>
and/or offset=<number>
.
// returns 10 teams starting from the 10th// GET /teams?limit=10&offset=10 // results in a Sequelize query:Team
order
queries
You can change the order of the resulting query by passing order
to the query.
// returns the teams ordered by the name column// GET /teams?order[]=name // results in a Sequelize query:Team
// returns the teams ordered by the name column, descending// GET /teams?order[0]=name&order[0]=DESC// GET /teams?order=name%20DESC // results in a Sequelize query:Team
// returns the teams ordered by the name, then the city columns, descending// GET /teams?order[0]=name&order[1]=city // results in a Sequelize query:Team
You can even order by associated models. Though there is a sequelize bug that might prevent this from working properly. A workaround is to &include
the model you're ordering by.
// returns the players ordered by the team name// GET /players?order[0]={"model": "Team"}&order[0]=name // results in a Sequelize query:Player // if the above returns a Sequelize error: `No such column Team.name`,// you can work around this by forcing the join into the query:// GET /players?order[0]={"model": "Team"}&order[0]=name&include=team // results in a Sequelize query:Player
Authorization and other hooks
You can use Hapi's ext
option to interact with the request both before and after this module does. This is useful if you want to enforce authorization, or modify the request before or after this module does. Hapi has a full list of hooks you can use.
Modify the response format
By default, hapi-sequelize-crud
routes will respond with the full model. You can modify this using the built-in hapi settings.
await
Full list of methods
Let's say you have a many-to-many
association like this:
Team;Role;
You get these:
# get an array of records
GET /team/{id}/roles
GET /role/{id}/teams
# might also append `where` query parameters to search for
GET /role/{id}/teams?members=5
GET /role/{id}/teams?city=healdsburg
# you might also use scopes
GET /teams/{scope}/roles/{scope}
GET /team/{id}/roles/{scope}
GET /roles/{scope}/teams/{scope}
GET /roles/{id}/teams/{scope}
# get a single record
GET /team/{id}/role/{id}
GET /role/{id}/team/{id}
# create
POST /team/{id}/role
POST /role/{id}/team
# update
PUT /team/{id}/role/{id}
PUT /role/{id}/team/{id}
# delete
DELETE /team/{id}/roles #search and destroy
DELETE /role/{id}/teams?members=5
DELETE /team/{id}/role/{id}
DELETE /role/{id}/team/{id}
# include
# include nested associations (you can specify an array if includes)
GET /team/{id}/role/{id}?include=SomeRoleAssociation
# you also get routes to associate objects with each other
GET /associate/role/{id}/employee/{id} # associates role {id} with employee {id}
# you can specify a prefix to change the URLs like this:
GET /v1/team/{id}/roles