Blueprint Routes
When you run sails lift with blueprints enabled, the framework inspects your controllers, models, and configuration in order to bind certain routes automatically. These implicit blueprint routes (sometimes called "shadow routes", or even just "shadows") allow your app to respond to certain requests without you having to bind those routes manually in your config/routes.js file. By default, the blueprint routes point to their corresponding blueprint actions (see "Blueprint Actions" below), any of which can be overridden with custom code.
There are three types of blueprint routes in Sails:
- RESTful routes, where the path is always
/:modelIdentityor/:modelIdentity/:id. These routes use the HTTP "verb" to determine the action to take; for example aPOSTrequest to/userwill create a new user, and aDELETErequest to/user/123will delete the user whose primary key is 123. In a production environment, RESTful routes should generally be protected by policies to avoid unauthorized access. - Shortcut routes, where the action to take is encoded in the path. For example, the
/user/create?name=joeshortcut creates a new user, while/user/update/1?name=mikeupdates user #1. These routes only respond toGETrequests. Shortcut routes are very handy for development, but generally should be disabled in a production environment. - Action routes, which automatically create routes for your custom controller actions. For example, if you have a
FooController.jsfile with abarmethod, then a/foo/barroute will automatically be created for you as long as blueprint action routes are enabled. Unlike RESTful and shortcut routes, action routes do not require that a controller has a corresponding model file.
See the blueprints subsection of the configuration reference for blueprint configuration options, including how to enable / disable different blueprint route types.
For a better experience on sailsjs.com, update your browser.
Built with Love
The Sails framework is maintained by a web & mobile studio in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.