Blueprint API
概要
ブループリントの概念的な概要については、概念 > ブループリント を参照してください。
アプリでのブループリントルートの有効化/無効化
ブループリントの有効化/無効化のプロセスは、対象となるブループリントルートの種類（RESTfulルート、ショートカットルート、またはアクションルート）によって若干異なります。異なるブループリントのタイプについては、ブループリントルートのドキュメントセクションを参照してください。
ブループリントのオーバーライド
ブループリントルートを変更するには、カスタムルートを明示的に設定することをお勧めします。同様に、ブループリントアクションをオーバーライドする場合は、独自のカスタムアクションを作成することをお勧めします。
しかし、本当に自分が何をしているのか理解している場合は、読み進めてください。
RESTful/ショートカットルートとアクション
単一のモデルのRESTfulブループリントルートをオーバーライドするには、関連するコントローラーファイル（または関連するフォルダーのスタンドアロンアクション）に、適切な名前（find、findOne、create、update、destroy、populate、add、またはremove）のアクションを作成するだけです。
すべてのモデルの特定のブループリントをオーバーライドする場合は、sails-hook-custom-blueprints プラグインをチェックしてください。これらを自分で定義していなくても、Sailsは、アクションまたはショートカットブループリントがブループリント構成で有効になっている限り、各モデルに対して組み込みのCRUDロジックをJSON APIの形式で応答すること（ソート、ページネーション、フィルタリングのサポートを含む）を理解することが重要です。
ブループリントとリソースフルPubSub
ブループリントAPIは、仮想リクエストインタープリターのおかげで、WebSocketと互換性があります（カスタムアクションとポリシーも同様です）。使用例については、ブラウザSDKの参照セクション（リファレンス > WebSockets > sails.io.js）を参照してください。
ブループリントと.subscribe()
デフォルトでは、FindおよびFind Oneブループリントアクションは、ソケットリクエストが使用された場合に.subscribe()を自動的に呼び出します。これにより、リクエスト元のソケットが返された各レコードにサブスクライブされます。ただし、同じソケットがio.socket.put()（たとえば）を使用してUpdateまたはDestroyアクションにリクエストを送信した場合、デフォルトではリクエスト元のソケットにメッセージが送信されず、他の接続され、サブスクライブされたソケットにメッセージが送信されます。これは、UIコードがクライアントサイドSDKのコールバックを使用してサーバーの応答を個別に処理できるようにすることを目的としています（例：ローディングスピナーを置き換える）。
ブループリントと「自動監視」
デフォルトでは、findブループリントアクション（WebSocketリクエストを介してトリガーされた場合）は、リクエスト元のソケットを、そのモデルの新しいインスタンスが作成されたことに関する通知にサブスクライブします。この動作は、sails.config.blueprints.autoWatchをfalseに設定することで、すべてのモデルに対して変更できます。
コントローラーごとのブループリントルートの無効化
次の手法は、互換性の理由でのみサポートされています。ブループリントアクションを使用しているかどうかに関係なく、カスタムルートを使用してください！
スタンドアロンアクションファイルではなくコントローラーを使用している場合は、コントローラー定義に_configキーを定義することにより、config/blueprints.jsの特定の設定をコントローラーごとに無効にすることができます。
// In /api/controllers/PetController.js
module.exports = {
_config: {
actions: false,
shortcuts: false,
rest: false
}
}
コントローラーごとの
shortcutsスタイルの自動ルートの無効化はサポートされていません。これは、本番環境でshortcuts: trueを使用するべきではないため、決して必要ありません。
sailsjs.com でより良い体験をするために、ブラウザを更新してください。
リファレンス
- アプリケーション
- Blueprint API
- コマンドラインインターフェース
-
構成
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
リクエスト (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- 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.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- レスポンス (`res`)
- Waterline (ORM)
- WebSocket
リファレンス
愛を込めて構築されました
Sailsフレームワークは、テキサス州オースティンのウェブ＆モバイルショップによって、コントリビューターの助けを借りて構築されています。私たちは2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然のことながら、私たちはそれをオープンソース化しました。それがあなたの生活を少しでも楽にすることを願っています！
© 2012-2024 The Sails Company.
SailsフレームワークはMITライセンスの下で無料でオープンソースです。
イラスト：Edamame。