Apidog

オールインワンのAPI開発プラットフォーム

API設計

API仕様書生成

API設計

API Mock

APIテスト自動化

無料登録
Home / ソリューション / 解決済み:GETメソッドでHTTPボディを使用できない?

解決済み:GETメソッドでHTTPボディを使用できない?

HTTP通信では、リクエストのボディは重要な役割を果たしています。しかし、GETメソッドの場合、HTTPボディを使わずURLパラメータでデータを渡すのが一般的です。本記事では、GETとボディの関係、GETのデータ渡し方などについて解説した上、GETメソッドでHTTPボディを本当に使用できないのかについても考察していきたいと思います。

HTTP通信では、リクエストのボディは重要な役割を果たしています。しかし、GETメソッドの場合、HTTPボディを使わずURLパラメータでデータを渡すのが一般的です。本記事では、GETとボディの関係、GETのデータ渡し方などについて解説した上、GETメソッドでHTTPボディを本当に使用できないのかについても考察していきたいと思います。

GETメソッドとは、HTTPボディとは関係は?

GETメソッドは一番汎用されているHTTPメソッドとして、サーバーからデータを取得するために利用されることが多いのです。サーバーから特定のデータを取得するために、URLパラメータを使用してデータを渡すのが一般的になります。だから、原則としてGETメソッドがリクエストボディを持つことはありません。

GETメソッドとは|簡単にGETリクエストを送信する方法
GETメソッドは、HTTPプロトコルにおける主要なリクエストメソッドの一つです。主にサーバーからデータを取得する際に使われるhttpメソッドになります。本文では、GETメソッドを詳しく紹介した上、GETリクエストを簡単に送信する方法を解説します。

GETメソッドでのデータの渡し方

GETリクエストは一般的にHTTPボディの代わりにパラメータを使用してサーバーにデータを渡しています。使用可能なパラメータには主に以下のようなタイプがあります。

  • クエリパラメータ

URLの?以降にキーと値の形式で指定するパラメータ。

例: ?id=1234&name=abc

  • パスパラメータ

URLのパスの一部として指定するパラメータ。

例: /items/{id} の {id} 部分

  • ヘッダーパラメータ

リクエストヘッダーに指定するパラメータ。

例: X-Custom-Header: value

  • クッキーパラメータ

Cookieヘッダーで指定するパラメータ。

例: Cookie: id=1234; name=abc

この中で、クエリパラメータが最も一般的ですが、APIの設計などで状況に応じてこれらのパラメータを使い分けます。これらのパラメータを使用してデータを渡すときに、URLエンコードに注意する必要があります。例えば、特殊文字は%エンコードする必要があります。また、GETメソッドのパラメータは直接にURLの後ろに追加するので、ブラウザやWebサーバーのURL最大長を超えないようにURLの長さ制限に気をつける必要があります。

以上のように、GETの特性やパラメータの基本情報を理解した上で、適切にデータを渡す方法を選択することが重要です。HTTPリクエストボディを使用して、データをサーバーに送信する必要がある場合は、POSTメソッドなどの他のHTTPメソッドを利用するのが適切です。

GETメソッドはHTTPボディを使用しない原因

なぜかGETメソッドはHTTPボディを使用しませんか?次は、GETメソッドがリクエストボディを利用しない主な理由を紹介します。

HTTPの仕様上の制限

  • HTTPの仕様では、GETメソッドのリクエストは再送信が安全でなければならないと定められている
  • リクエストボディがあると、再送信時に意図しない副作用が発生する可能性がある

イデンポテンシーの保証

  • GETメソッドは「同じGETリクエストを繰り返しても結果が変わらない」イデンポテンシーを保証する必要がある
  • リクエストボディがあるとイデンポテンシーが損なわれる可能性がある

キャッシュの実装

  • GETの結果はキャッシュして再利用することが多い
  • リクエストボディがあるとキャッシュが機能しない

ブックマークや共有のしやすさ

  • GETリクエストのURLだけで結果を再現できることが望ましい
  • リクエストボディがあるとURLのみでの再現が難しくなる

セキュリティ

  • GETリクエストはログ等に記録されることがある
  • リクエストボディに個人情報等が含まれるとセキュリティリスクになる

以上の原因のため、GETメソッドは基本的にリクエストボディを利用しません。

例外あり:GETメソッドでもHTTPボディを利用する場合

ただし、GETメソッドでは必ずHTTPボディを使用していけないわけでもありません。以下のような場合にはGETメソッドでもリクエストボディを送信することがあります。

検索条件を指定する場合

  • 検索キーワードなどをリクエストボディに含めて送信することがある

APIでのパラメータ送信

  • REST APIなどで、GETメソッドのクエリパラメーターの数が制限される場合に、代わりにリクエストボディを使用することがある

リクエストスマグリング

  • トラフィック解析を妨害するために、偽のリクエストボディを送信することがある

ということで、GETメソッドは原則としてリクエストボディを利用しませんが、必ずしもそうではありません。検索条件を指定する必要がある場合など、例外となります。また、HTTPボディを使用してデータを送信する場合は、POSTやPUTなどのメソッドを利用するのが普通です。

Apidog:全てのHTTPメソッドにも全面的にご対応

それでは、GETやPOSTなどのメソッドを使って、HTTPボディでデータを送信したい場合、どうしたらいいですか?Apidogという優れていたAPI管理ツールは、全てのHTTPメソッドにも全面的に対応できるので、HTTPリクエストを送信する時にいずれかのHTTPメソッドを指定したり、HTTPボディを利用するかどうかを選択したりすることができます。また、自分でAPIを開発する場合は、APIの設計だけではなく、APIの仕様書生成、テスト自動化、データモックなど、様々な機能もできます。

button

Apidogでは、GETやPOSTを含む様々なHTTPメソッドにも対応できます。どちらのWeb APIもHTTPプロトコルを使用していますので、目的別で、HTTPメソッドを選択する必要があります。HTTPメソッドといえば、常に下記のものがあります。

  • GET(コンテンツを取得)
  • POST(コンテンツを新規追加)
  • PUT(既存コンテンツを変更)
  • DELETE(コンテンツを削除)
APIメソッドを設定

HTTPメソッドのドロップダウンリストから希望のメソッドを選択することもできますし、HTTPボディを利用したい場合、Requestパラメータの「Body」タブに切り替えて簡単に利用できます。

button

Apidogのニュースレターを購読する

今すぐ購読すると、いつでもApidogから更新情報と最新観点を手に入れることができます。