アプリケーションを開発している中、Web APIを取り扱っていることがすでに不可欠なことになってしまいました。そこで、httpリクエストをやり方を知っておく必要があります。本文では様々なhttpリクエストのやり方を皆さんに紹介して、httpリクエストを簡単に確認することができるようにします。
httpリクエストとは
HTTPリクエストとは、クライアントからサーバーにデータを要求するために送信されるメッセージのことです。httpリクエストでは次のような特徴があります:
- テキストベースのフォーマットを使用している
- HTTPメソッド(GET、POSTなど)で要求の種類を指定する
- URIでリソースを指定する
- ヘッダーに追加情報を設定できる
- ボディにデータを含めることができる
リクエストを送信すると、サーバーはそれに対応するHTTPレスポンスを返します。レスポンスにはステータスコード、ヘッダー、ボディが含まれます。このリクエストとレスポンスのやり取りで、ウェブブラウザとウェブサーバーなどの通信が行われています。良く知る必要がある基本的な技術です。
httpリクエストの基本構造
httpのリクエストの基本構造といえば、以下の通りです。
<メソッド> <リクエストURI> <バージョン>
<ヘッダー1>: <値1>
<ヘッダー2>: <値2>
...
<ボディ>
それでは、httpリクエストにおける各部分についてそれぞれ詳しく皆さんに紹介していきたいと思います。
- メソッド - GET、POSTなどのHTTPメソッドを指定
- リクエストURI - アクセスするリソースのURI
- バージョン - HTTPのバージョン(通常HTTP/1.1)
- ヘッダー - リクエストのメタデータ(ホスト、内容長など)
- ボディ - POSTなどのリクエストにデータを含めることができる
httpリクエスト例
GET /index.html HTTP/1.1
Host: www.example.com
Content-Type: text/html
...
このように、メソッド、URI、ヘッダー、ボディから構成されます。リクエストの目的に応じてこの構造を使い分けます。
httpリクエストのやり方
この部分では、HTTPリクエストを送信する基本的やり方を皆さんに紹介します。httpリクエストのやり方は主に次の流れになっています。
リクエストラインを作成する
- メソッド(GET、POSTなど)、リクエストURI、HTTPのバージョンを指定
ヘッダーを追加する
- Host、Content-Type、Cookieなど必要なヘッダーを記述
ボディを作成する
- POSTなどの場合、リクエストのボディにデータを設定
作成したリクエストを送信する
- cURL、Postman、プログラミング言語のライブラリなどを利用して送信
レスポンスを受信する
- サーバーはリクエストに対するレスポンスを返す
レスポンスを確認する
- ステータスコード、ヘッダー、ボディを確認し、期待どおりか判断
リクエストはAPIクライアント、HTTPライブラリやコマンドラインツールを使うこと送信できますが、ヘッダーやボディの内容を適切に設定することに注意を払う必要があります。
httpリクエストの確認方法:送信してレスポンスを取得
上記の内容から、httpリクエストの基本情報を理解できたと思いますが、それでは、httpリクエストを送信して、レスポンスを取得するには、どうしたらいいですか?次はhttpリクエストの基本的なやり方を皆さんに紹介します。
APIクライアントApidogでhttpリクエストを確認
httpリクエストを確認したい場合は、一番簡単な対策はAPIクライアントを使うことです。ここでApidogという直感的なAPIクライアントを皆さんにお勧めします。このAPIクライアントを使うと、コードが全く要らなくて、直感的な操作によって、httpリクエストを簡単に送信してレスポンスを取得できます。また、レスポンスの自動検証機能も備えて、返してくれたレスポンスに不具合があるかどうかっていうことも自動的に検証できますので、非常に便利です。
Apidogを使うと、下記画像のように、非常に直感的なUIで、APIリクエストを作成して、必要な情報(メソッド、URI、必須のパラメータなど)を記入して、リクエストを「送信」できます。
リクエストを送信すると、APIエンドポイントからのレスポンスをすぐに取得することができますし、レスポンス内容の自動検証もその同時に行われますので、非常に便利です。
Chromeでhttpリクエストを確認
また、Chromeでhttpリクエストを直接に確認したい場合、Apidogを利用することも可能です。Apidogは、デスクトップ版と同じように強力的なChrome拡張機能を提供していますので、その拡張機能をChromeに追加すると、上記と全く同じな操作によって、簡単にhttpリクエストを確認できます。
ApidogのChrome拡張機能のページにアクセスして、「Chromeに追加」ボタンをクリックして、それをChromeに追加します。
そして、上記のデスクトップバージョンのように、直感的な操作でhttpリクエストを送信して確認することができます。
cURLでhttpリクエストを確認
CURLとは、コマンドラインからHTTPリクエストを送信するためのオープンソースのライブラリやツールのことです。cURLを利用して、httpリクエストを確認したい場合は、次のステップを参照してください。
ステップ⒈cURLをパソコンにインストールします。
ステップ⒉送信するhttpリクエストに応じて、必要なcURLのオプションを利用します。
ステップ⒊次のようなコマンドで、httpリクエストを送信してレスポンスを取得します。
curl -d 'param1=value1' -H 'Content-Type: application/json' https://example.com
cURLについて、より詳しいhttpリクエストの確認方法は、次の記事を参照してください。