1. ホーム
  2. http

[解決済み] カスタムHTTPヘッダー:命名規則

2022-03-15 03:23:43

質問

いくつかのユーザーから、自分のアカウントに関するデータを HTTPヘッダ を送信する際、またはAPIから取得するレスポンスでさえも。 カスタムHTTPヘッダーを追加するための一般的な規約は、以下のとおりです。 ネーミング , フォーマット ... など

また、ウェブ上で見つけたこれらのスマートな使い方があれば、遠慮なく投稿してください。)

解決方法は?

おすすめポイント <ストライク は でした。 のように、名前の先頭に "X-"を付けてください。例 X-Forwarded-For , X-Requested-With . のa.o.5項にも記載されています。 RFC 2047 .


アップデート1 : 2011年6月に、最初の IETFドラフト に投稿されました。 デペッシュ 非標準のヘッダには "X-" という接頭辞を使うことを推奨しています。その理由は、"X-" をプレフィックスとする非標準ヘッダが標準になったとき、"X-" を削除すると下位互換性が壊れ、アプリケーションプロトコルは両方の名前をサポートしなければならないからです(例: X-".com)。 x-gzip & gzip は等価になりました)。そこで、公式には以下のような名前を付けることが推奨されています。 感覚的に X-"の接頭辞を付けないでください。


アップデート2 : 2012年6月、"X-"接頭辞の使用推奨の廃止が正式に決定されました。 RFC 6648 . 以下、関連性の高いものを引用します。

<ブロッククオート

3. 新しいパラメータを作成するための推奨事項

...

  1. パラメータ名の前に "X-" または類似のものを付けてはいけません (SHOULD)。 の構文を使用する。
<ブロッククオート

4. プロトコル設計者への提言

...

  1. プレフィックスが "X-" であるパラメータや、それに類似したパラメータを禁止してはならない。 を登録することができます。

  2. プレフィックスが "X-"であるパラメータ、またはそのようなパラメータがあることを規定してはならない(MUST NOT)。 同様の構成は、標準化されていないものとして理解する必要があります。

  3. 接頭辞のないパラメータ、または、X-quot(X-")のないパラメータを規定してはならない。 同様の構成は、標準化されたものとして理解される必要があります。

なお、quot;SHOULD NOT" ("discouraged") は "MUST NOT" ("forbidden") と同じではないので、以下もご参照ください。 RFC 2119 は、これらのキーワードに関する別の仕様です。言い換えれば、あなたは "X-" プレフィックス付きヘッダを使い続けることができますが、それはもう公式には推奨されていませんし、あたかもそれが公的な標準であるかのように文書化することは絶対に避けてください。


概要 :

  • 公式の推奨は、単に名前を付けることです。 感覚的に X-"のプレフィックスを付けないでください。
  • X-"プレフィックス付きヘッダを使い続けることはできますが、公式にはもう推奨されていませんし、公共規格であるかのような文書化は絶対にやめましょう。