req.wantsJSON
リクエスト元のクライアントが、（XMLやHTMLのような他のフォーマットではなく）JSONレスポンスを優先するかどうかを示すフラグ。
req.wantsJSON は、Sails の 組み込みのカスタムレスポンスすべてで使用されます。
使用法
req.wantsJSON;
詳細
req.wantsJSON の意図された目的は、サーバーがJSONで応答すべきか、それとも何か別のものを返す必要があるかを明確かつ再利用可能な形で示すことです。これは、すべてのコンテンツネゴシエーション問題に対する正しい答えではありませんが、ほとんどのユースケースに対するシンプルで頼りになるソリューションです。
例えば、主要なブラウザはすべて、URLフィールドに入力されたリクエストに対して "Accept: text/plain;" リクエストヘッダーを設定します。この場合、req.wantsJSON は false になります。ただし、他の多くの場合では、区別があまり明確ではありません。これらのシナリオでは、Sails はヒューリスティックを使用して req.wantsJSON の最適な値を決定します。
技術的には、req.wantsJSON はリクエストの "Content-type"、"Accepts"、および "X-Requested-With" ヘッダーを検査して、リクエストがJSONレスポンスを期待しているかどうかを判断します。これらのヘッダーの情報が不十分な場合、Sails はJSONを優先し、req.wantsJSON は true に設定されます。
req.wantsJSON の利点は、アプリの将来性を保証し、脆弱性を減らすことです。コンテンツネゴシエーションのベストプラクティスが時間の経過とともに変化するにつれて（例：新しいタイプのコンシューマーデバイスやエンタープライズユーザーエージェントが新しいヘッダーを導入するなど）、Sailsはフレームワークレベルで req.wantsJSON にパッチを適用し、それに応じてヒューリスティックを修正できます。また、コードの重複を減らし、各ルートでヘッダーを手動で検査する煩わしさを軽減します。
例
if (req.wantsJSON) {
sails.log('This request wants JSON!');
}
else {
// `req.wantsJSON` is falsy (undefined), to this request must not want JSON.
}
詳細
以下は、req.wantsJSON がリクエストを検査する具体的な順序です。以下のいずれかが一致した場合、後続のチェックは無視されます。
リクエストは、以下の場合に "wantsJSON" とみなされます。
- AJAXリクエストのように見える場合
- ソケットからの仮想リクエストである場合
- リクエストが明示的にHTMLを要求していない場合
- リクエストに "json" コンテンツタイプがあり、かつ "Accept" ヘッダーが設定されている場合
req.options.wantsJSONが真の場合
備考
- もちろん、
req.is()、req.accepts()、req.xhr、およびreq.get()を使用して、より低レベルのコンテンツネゴシエーションも可能です。- Sails v0.10 以降では、WebSocketクライアントからのリクエストは常にJSONを要求します。
sailsjs.com をより快適にご利用いただくには、ブラウザを更新してください。
リファレンス
- アプリケーション
- ブループリント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によるものです。