GETはAPIテスト時に一番汎用されているHTTPメソッドとして、サーバーから何かの情報を取得するために利用されています。本文では、GETで利用可能なパラメータを紹介して、一番使いやすいAPIテストツールのApidogを使って、GETリクエストを送信する方法を皆さんに紹介します。
Apidogは、APIの設計、仕様書生成と共有、単体テストとシナリオ自動化、APIモックサーバーにも対応できるツールとして、API戦略の推進を全面的に支援してくれるツールです。GETでパラメータを付けてリクエストを送信することはApidogによって簡単に実現可能なので、本文の内容を読み続けてください。
GETとは
前述のように、GETはHTTPメソッドの1つで、サーバーから何かのデータを取得するために使用されます。そこで、GETメソッドは、データ検索やデータ取得の利用シーンでは非常に汎用されています。
GETの特徴といえば、主に以下の通りです：
- サーバにデータを要求するだけで、サーバのデータを変更しないメソッドです。
- リクエストのbodyを持たないのが通常です。パラメーターはURLのクエリ文字列に含まれます。
- データの取得がメインの目的なので、キャッシュ可能なメソッドとして設計されています。
- 幂等性が保証されているため、同じGETリクエストを繰り返しても結果が変わらないのが原則です。
- セキュリティ的には比較的安全なメソッドと考えられています。
GETでパラメータを利用
上記の内容から、GETはサーバーからデータを取得するのが目的になりますので、GETリクエストを送信する時に使われるパラメータにはどういう役割がありますか？実際には、GETリクエストを送信して、取得するデータは何かを指定するために、パラメータを使用します。
GETで利用可能なパラメータは、主にパスパラメータとクエリパラメータになり、この2つのパラメータも直接にURLに反映さえているため、URLパラメータとも呼ばれることが多いのです。
クエリパラメータ
クエリパラメータとは、URLに含まれるキーと値のペアのことです。具体的には、URLの?以降にあるキーと値のペア形式で指定されるパラメータのことを指します。また、?以降の全てのデータもString（ストリング）としてサーバーに送信するので、?以降のテキストもクエリストリングと呼ばれています。
例えば、以下のようなURLの場合:
http://example.com/search?keyword=AI&page=2
ここで、2つのクエリパラメータがあります：
- keyword=AI
- page=2
クエリパラメータは、サーバーに対して追加の情報を渡すために利用されます。この例の場合、検索キーワードと表示ページを指定しているため、キーワードがAIで2番目の検索結果ページのデータを結果として返されます。
パスパラメータ
パスパラメータは、URLパラメータの一種として、URLのパスの中に埋め込まれた変数のようなものです。
例えば以下のようなURLの/users/12345の部分がパスパラメータの例です。
http://example.com/users/12345
ここで12345の部分がユーザーIDなどを表す変数となっています。
このように、APIのエンドポイントにおいて、動的な値をパスの一部として指定することがパスパラメータです。
ApidogでGET：簡単にパラメータを追加可能に
使いやすいAPIクライアントのApidogを使用して、クエリパラメータを指定してサーバーに送信する方法を紹介します。
Apidogの直感的なUIで、APIのエンドポイントを記入して「送信」ボタンをクリックするだけで、リクエストを送信して、レスポンスを取得できます。
例えば、GETリクエストを送信する場合、URLを記入するだけで、URLに含まれるクエリパラメータとパスパラメータが自動的に抽出され、下のパラメータ欄に記入されるので、非常に便利です。例えば：
GET https://example.com/search?keyword=cat&sort=asc&num=30
をURLボックスに記入すると、keyword、sort、numといった3つのクエリパラメータは自動的に下記のQueryパラメータ欄に抽出できます。
また、ApidogがエンドポイントURLにパスパラメータが含まれることを検出できた場合は、それを自動的にパスパラメータに抽出されます。例えば以下のURLを入力すると、
/users/{userId}
userIdという名前のパスパラメータがGUIで作成され、値を簡単に設定できるようになります。パラメータ値の入力ボックスの魔法の杖のアイコンをクリックして、パラメータ値をダイナミック値に設定することもできるので、非常に便利です。
このように、ApidogでGETリクエストを送信して、「保存」ボタンをクリックすると、作成したリクエストは保存し、後から直接に再利用することもできるので、非常に便利です。
まとめ
この記事では、APIテスト時にGETリクエストを送信する際に、どのようなパラメータを利用できるかについて解説しました。GETリクエストでは、主にクエリパラメータとパスパラメータの2種類が利用できます。
これらのパラメータを簡単に指定できるAPIテストツールとして、Apidogを紹介しました。ApidogではURLを入力するだけでパラメータが自動抽出され、グラフィカルなUIで値を簡単に設定できます。また、リクエストの保存・再利用もでき非常に便利です。
