何人かのユーザーから、私たちが送信するリクエストのHTTP ヘッダー、または API から受け取る応答に、自分のアカウントに関連するデータを含めるようにとの要望がありました。名前、形式などに関して、カスタム HTTP ヘッダーを追加する一般的な規則は何ですか。
また、Web 上で見つけたこれらの賢い使い方を自由に投稿してください。私たちは、最高のものを目標としてこれを実装しようとしています :)
ベストアンサー1
名前を「X-」で始めることをお勧めします
。 例:
X-Forwarded-For、X-Requested-Withこれは、第5節にも記載されています。RFC 2047。
アップデート1：2011年6月、最初のIETFドラフト非標準ヘッダーに「X-」プレフィックスを使用するという推奨を廃止するために投稿されました。その理由は、「X-」プレフィックスが付いた非標準ヘッダーが標準になったときに、「X-」プレフィックスを削除すると下位互換性がなくなり、アプリケーション プロトコルが両方の名前をサポートするように強制されるからです (例: x-gzip&は現在同等です)。したがって、公式の推奨事項は、「X-」プレフィックスなしで適切gzipな名前を付けることです。
更新2 : 2012年6月、「X-」プレフィックスの使用の推奨が正式に廃止されました。RFC 6648以下は関連する引用です:
3. 新しいパラメータの作成者への推奨事項
...
- パラメータ名の前に「X-」または同様の構造を付けないでください。
4. プロトコル設計者への推奨事項
...
「X-」プレフィックスまたは同様の構造を持つパラメータの登録を禁止しないでください。
「X-」プレフィックスまたは同様の構造を持つパラメータが非標準化として理解される必要があると規定してはなりません。
「X-」プレフィックスまたは同様の構造を持たないパラメータは標準化されたものとして理解される必要があると規定してはなりません。
「すべきではない」（「非推奨」）は「してはならない」（「禁止」）と同じではないことに注意してください。RFC 2119これらのキーワードに関する別の仕様については、こちらを参照してください。つまり、「X-」プレフィックスの付いたヘッダーを引き続き使用することはできますが、これはもはや公式には推奨されておらず、公開標準であるかのように文書化することは絶対にできません。
まとめ：
- 公式の推奨は、「X-」接頭辞なしで、単に意味のある名前を付けることです。
- 「X-」プレフィックス付きヘッダーを使い続けることもできますが、これはもはや公式には推奨されておらず、公開標準であるかのように文書化することは絶対にできません。