web-dev-qa-db-ja.com

REST APIのベストプラクティス-一意のリクエスト識別子を配置する場所

REST APIを設計する場合、httpリクエストを実行するときにunique request identifierを追加するためのベストプラクティスは何ですか?

通常はヘッダーにx-request-idとして追加しますが、今日、誰かがURLにクエリ文字列として追加することに言及しているのを聞きました。

また、調査を行った後、応答本文に追加してペイロードの一部として送信する人もいるようです。

これらの3つのうち、unique request identifierの最適なアプリケーションはどれですか?その理由は何ですか?各アプローチの可能な長所と短所は何ですか?

5
hyprstack

HTTPにはリクエスト識別子は含まれません 。ただし、デバッグやログ拡張のために(、たとえば)が必要な場合は、任意のヘッダー(X-Request-IdまたはX-Correlation-Idはいくつかの例です)。値は [〜#〜] uuid [〜#〜] の場合があります。

ヘッダーを使用する理由は、すべてのリクエストメソッドがリクエストペイロードをサポートしているわけではないためです。


この 記事 はおそらくあなたにいくつかの洞察を与えるでしょう。

1
cassiomolin