Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
baucis - npm Package Compare versions
Comparing version 0.3.1-4 to 0.3.1-5
| { | ||
| "name": "baucis", | ||
| "version": "0.3.1-4", | ||
| "version": "0.3.1-5", | ||
| "main": "index.js", | ||
@@ -5,0 +5,0 @@ "scripts": { |
143
README.md
@@ -1,2 +0,2 @@ | ||
| baucis v0.3.1-4 | ||
| baucis v0.3.1-5 | ||
| =============== | ||
@@ -55,65 +55,2 @@ | ||
| Use plain old Connect/Express middleware, including pre-existing modules like `passport`. For example, set the `all` option to add middleware to be called before all the model's API routes. | ||
| baucis.rest({ | ||
| singular: 'vegetable', | ||
| all: function (request, response, next) { | ||
| if (request.isAuthenticated()) return next(); | ||
| return response.send(401); | ||
| } | ||
| }); | ||
| Or, set some middleware for specific HTTP verbs or disable verbs completely: | ||
| baucis.rest({ | ||
| singular: 'vegetable', | ||
| get: [middleware1, middleware2], | ||
| post: middleware3, | ||
| del: false, | ||
| put: false | ||
| }); | ||
| `baucis.rest` returns an instance of the controller created to handle the schema's API routes. | ||
| var subcontroller = baucis.rest({ | ||
| singular: 'bar', | ||
| basePath: '/:fooId/bars' | ||
| publish: false, // don't add API routes automatically | ||
| restrict: function (query, request) { | ||
| // Only retrieve bars that are children of the given foo | ||
| query.where('parent', request.params.fooId); | ||
| } | ||
| }); | ||
| var controller = baucis.rest({ | ||
| singular: 'foo', | ||
| configure: function (controller) { | ||
| // Embed the subcontroller at /foos/:fooId/bars | ||
| controller.use(subcontroller); | ||
| // Embed arbitrary middleware at /foos/qux | ||
| controller.use('/qux', function (request, response, next) { | ||
| // Do something cool… | ||
| next(); | ||
| }); | ||
| } | ||
| }); | ||
| Controllers are Express apps, so do whatever you want with them. | ||
| var controller = baucis.rest({ | ||
| singular: 'robot', | ||
| configure: function (controller) { | ||
| // Add middleware before all other rotues in the controller | ||
| controller.use(express.cookieParser()); | ||
| } | ||
| }); | ||
| // Add middleware after default controller routes | ||
| controller.use(function () { ... }); | ||
| controller.set('some option name', 'value'); | ||
| controller.listen(3000); | ||
| Baucis uses the power of Express, without getting in its way. It's meant to be a way to organize your REST API's Express middleware. | ||
| Also note that Mongoose middleware will be executed as usual. | ||
@@ -213,2 +150,80 @@ | ||
| `bacuis.rest` | ||
| ------------- | ||
| Use plain old Connect/Express middleware, including pre-existing modules like `passport`. For example, set the `all` option to add middleware to be called before all the model's API routes. | ||
| baucis.rest({ | ||
| singular: 'vegetable', | ||
| all: function (request, response, next) { | ||
| if (request.isAuthenticated()) return next(); | ||
| return response.send(401); | ||
| } | ||
| }); | ||
| Or, set some middleware for specific HTTP verbs or disable verbs completely: | ||
| baucis.rest({ | ||
| singular: 'vegetable', | ||
| get: [middleware1, middleware2], | ||
| post: middleware3, | ||
| del: false, | ||
| put: false | ||
| }); | ||
| RESTful Headers | ||
| --------------- | ||
| * `Accept: application/json` is set for all responses. | ||
| * The `Allow` header is set automatically, correctly removing HTTP verbs when | ||
| those verbs have been disabled with e.g. `put: false`. | ||
| * The `Location` HTTP header is set for PUT and POST responses. | ||
| * If `relations: true` is passed to `baucis.rest`, HTTP link headers will be set for all responses. | ||
| Controllers | ||
| ----------- | ||
| `baucis.rest` returns an instance of the controller created to handle the schema's API routes. | ||
| var subcontroller = baucis.rest({ | ||
| singular: 'bar', | ||
| basePath: '/:fooId/bars' | ||
| publish: false, // don't add API routes automatically | ||
| restrict: function (query, request) { | ||
| // Only retrieve bars that are children of the given foo | ||
| query.where('parent', request.params.fooId); | ||
| } | ||
| }); | ||
| var controller = baucis.rest({ | ||
| singular: 'foo', | ||
| configure: function (controller) { | ||
| // Embed the subcontroller at /foos/:fooId/bars | ||
| controller.use(subcontroller); | ||
| // Embed arbitrary middleware at /foos/qux | ||
| controller.use('/qux', function (request, response, next) { | ||
| // Do something cool… | ||
| next(); | ||
| }); | ||
| } | ||
| }); | ||
| Controllers are Express apps, so do whatever you want with them. | ||
| var controller = baucis.rest({ | ||
| singular: 'robot', | ||
| configure: function (controller) { | ||
| // Add middleware before all other rotues in the controller | ||
| controller.use(express.cookieParser()); | ||
| } | ||
| }); | ||
| // Add middleware after default controller routes | ||
| controller.use(function () { ... }); | ||
| controller.set('some option name', 'value'); | ||
| controller.listen(3000); | ||
| Baucis uses the power of Express, without getting in its way. It's meant to be a way to organize your REST API's Express middleware. | ||
| Contact Info | ||
@@ -215,0 +230,0 @@ ------------ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.17%
269504
- Number of lines in readme file
- increased by6.85%
234
No dependency changes