sails.config.blueprints
These configurable settings allow you to configure the blueprint API in Sails. Some settings (like sails.config.blueprints.populate) control the behavior of built-in blueprint actions, whereas others (like sails.config.blueprints.shortcuts) tweak the behavior of blueprint routing and/or determine whether Sails automatically binds certain kinds of blueprint routes at all.
Properties
| Property | Type | Default | Details |
|---|---|---|---|
actions |
true |
Whether routes are automatically generated for every action in your controllers (also maps index to /:controller) '/:controller', '/:controller/index', and '/:controller/:action' |
|
rest |
true |
Automatic REST blueprints enabled? e.g. 'get /:controller/:id?' 'post /:controller' 'put /:controller/:id' 'delete /:controller/:id' |
|
shortcuts |
true |
These CRUD shortcuts exist for your convenience during development, but you'll want to disable them in production.: '/:controller/find/:id?', '/:controller/create', '/:controller/update/:id', and '/:controller/destroy/:id' |
|
prefix |
'' |
Optional mount path prefix for blueprints (the automatically bound routes in your controllers) e.g. '/api/v2' | |
restPrefix |
'' |
Optional mount path prefix for RESTful blueprints (the automatically bound RESTful routes for your controllers and models) e.g. '/api/v2'. Will be joined to your prefix config. e.g. prefix: '/api' and restPrefix: '/rest', RESTful actions will be available under /api/rest |
|
pluralize |
false | Optionally use plural controller names in blueprint routes, e.g. /users for api/controllers/UserController.js. |
|
populate |
true |
Whether the blueprint controllers should populate model fetches with data from other models which are linked by associations. If you have a lot of data in one-to-many associations, leaving this on may result in very heavy api calls. | |
defaultLimit |
30 |
The default number of records to show in the response from a "find" action. Doubles as the default size of populated arrays if populate is true. |
|
autoWatch |
true |
Whether to run Model.watch() in the find and findOne blueprint actions. Can be overridden on a per-model basis. |
|
jsonp |
false |
Optionally wrap blueprint JSON responses in a JSONP callback using res.jsonp() from Express 3. |
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command Line Interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
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.