express-restful-router
Usage
First off, install the package:
npm install express-restful-router --save
Then, require it in your project:
var RestfulRouter = ;
You can then pass a configuration option into the RestfulRouter
to return a new router:
var router = ;
Options
resource
Required: yes
Type:
String
Description: Sets the name of the resource for the restful router. The end-point is generated based on the name of the resource.
Example:
router = ;
By default, the following end-points are created:
GET /example
(maps to thelist
controller method)POST /example
(maps to thecreate
controller method)GET /example/:id
(maps to theshow
controller method)PUT /example/:id
(maps to theupdate
controller method)DELETE /example/:id
(maps to theremove
controller method)
controller
Required: yes
Type:
Object
Description:
Defines the controller that your restful router maps to.
By default, the methods it expects are: list
, create
, show
, update
, remove
.
For single-resource methods (such as show
, update
and remove
) the resource ID is available as req.params.id
.
Example:
router = ;
only
Required: no
Type:
[String]
Description: Define which pre-set routes are enabled.
Example:
router = ;
custom
Required: no
Type:
[String|Object]
Description:
Custom route configuration. May be a string (which creates a default getter with a method of the same name), or an object (where you can define action
, path
and method
).
Example:
router = ;