curl コマンド入門: GET メソッドでのデータ取得方法

はい、承知いたしました。curlコマンド入門として、特にGETメソッドでのデータ取得に焦点を当て、詳細な説明を含む約5000語の記事を記述します。


curl コマンド入門: GET メソッドでのデータ取得方法

はじめに:curlコマンドとGETメソッドの世界へようこそ

インターネット上のデータと対話する方法は多岐にわたりますが、その基本中の基本となるのが、HTTP(Hypertext Transfer Protocol)という通信プロトコルです。ウェブサイトの閲覧、APIからのデータ取得、ファイルのダウンロードなど、私たちが日々インターネット上で行う多くの操作は、このHTTPを介して行われています。

そして、このHTTP通信をコマンドラインから自由自在に操るための強力なツールが curl です。curlは、URL(Uniform Resource Locator)を使ってデータを送受信するための多機能なコマンドラインツールであり、ライブラリ(libcurl)でもあります。開発者、システム管理者、あるいは単にウェブの仕組みに興味がある人にとって、curlは必須のツールと言えるでしょう。

curlコマンドは様々なプロトコル(HTTP, HTTPS, FTP, FTPS, SCP, SFTPなど多数)をサポートしていますが、特にウェブ関連で最も頻繁に利用されるのがHTTP/HTTPSです。HTTPには、リソースに対する操作を定義するいくつかの「メソッド」があります。代表的なものには、GET, POST, PUT, DELETE などがあります。

この記事では、HTTPメソッドの中でも最も基本的かつ頻繁に使用される GETメソッド に焦点を当て、curlコマンドを使ってGETリクエストを送信し、ウェブ上のデータを取得する方法について、詳細かつ網羅的に解説します。

GETメソッドは、指定したURLからリソースを取得するために使用されます。ウェブブラウザのアドレスバーにURLを入力してウェブページを表示する行為は、まさにGETメソッドを使ったリクエストの一例です。APIから情報を取得する場合も、多くの場合GETメソッドが使用されます。

この記事を読むことで、あなたは以下のことができるようになります。

  • curlコマンドの基本的な使い方を理解する。
  • GETメソッドの役割と特徴を把握する。
  • curlを使ってウェブサイトやAPIからデータを取得する基本的な方法を学ぶ。
  • GETリクエストにパラメータを付加して送信する方法を理解する。
  • HTTPヘッダーを確認し、操作する方法を知る。
  • リダイレクトや認証、SSL/TLSといった高度なケースでのGETリクエストの扱い方を学ぶ。
  • 取得したレスポンスデータを効率的に処理する方法を知る。
  • curlをHTTP通信のデバッグやAPIテストに活用する方法を理解する。

コマンドラインツールに慣れていない方でも理解できるよう、基本的なことから順に解説し、多くの具体的なコマンド実行例と、その出力結果の詳細な説明を含めます。さあ、curlとGETメソッドの世界へ一緒に踏み出しましょう。

curlコマンドの基本を理解する

curlコマンドを使う前に、まずはあなたのシステムにcurlがインストールされているか確認しましょう。ほとんどのUnix系OS(Linux, macOSなど)には最初からインストールされています。Windowsでも、近年は標準で搭載されるようになりました。

curlのインストールと確認

ターミナルまたはコマンドプロンプトを開き、以下のコマンドを実行してください。

bash
curl --version

または

bash
curl -V

もしcurlがインストールされていれば、バージョン情報を含む出力が表示されます。

curl 7.81.0 (x86_64-pc-linux-gnu) libcurl/7.81.0 OpenSSL/3.0.2 zlib/1.2.11 brotli/1.0.9 zstd/1.4.8 libidn2/2.3.2 libpsl/0.21.0 (+libidn2/2.3.2) librtmp/2.3 OpenLDAP/2.5.16
Release-Date: 2022-02-02
Protocols: dict file ftp ftps gopher gophers http https imap imaps mqtt pop3 pop3s rtsp scp sftp smb smbs smtp smtps telnet tftp
Features: alt-svc AsynchDNS brotli GSS-API HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz NTLM NTLM_WB PSL SPNEGO SSL TLS-SRP UnixSockets zstd

このような出力が表示されれば、curlはインストール済みで使用可能です。

もしインストールされていなかった場合、各OSに応じた方法でインストールしてください。

  • Linux (Debian/Ubuntu系): sudo apt update && sudo apt install curl
  • Linux (Fedora/CentOS/RHEL系): sudo dnf install curl または sudo yum install curl
  • macOS: Homebrewを使っている場合 brew install curl。macOSには通常プリインストールされています。
  • Windows: PowerShell 7以降には標準搭載されています。古いバージョンやCommand Promptの場合は、Windows Package Manager (winget) で winget install curl.curl または公式ウェブサイトからダウンロードしてください。

インストール後、再度 curl --version を実行して確認してください。

基本的な構文

curlコマンドの最も基本的な構文は非常にシンプルです。

bash
curl [オプション] [URL]

例えば、ウェブサイトのトップページを取得したい場合は、そのURLを指定します。

bash
curl https://www.example.com/

このコマンドを実行すると、https://www.example.com/ のウェブページの内容(HTMLコード)がターミナルにそのまま表示されます。これが、最もシンプルなcurlコマンドによるGETリクエストの実行例です。

GETメソッドとは? HTTPメソッドの基本

HTTPプロトコルでは、クライアント(あなたのブラウザやcurlコマンド)がサーバーに対してどのような操作を行いたいかを「メソッド」で伝えます。GETメソッドはその中でも最も一般的で、リソースを取得するために設計されています。

HTTPメソッドの種類 (簡易版)

  • GET: 指定されたURIのリソースを取得します。データの参照に使われます。
  • POST: 指定されたURIにデータを送信し、新しいリソースを作成したり、既存のリソースを更新したり、特定の処理を実行したりします。
  • PUT: 指定されたURIにデータを送信し、そのURIにリソースを作成または完全に更新します。
  • DELETE: 指定されたURIのリソースを削除します。
  • HEAD: GETと同じですが、レスポンスボディを含まず、ヘッダー情報のみを取得します。
  • OPTIONS: 指定されたURIで利用可能なHTTPメソッドを問い合わせます。

GETメソッドの特徴

GETメソッドにはいくつかの重要な特徴があります。

  1. データの取得: 主にサーバー上のリソース(HTMLファイル、画像、データなど)を取得するために使用されます。
  2. 安全 (Safe): リソースの状態を変更するような副作用を持ちません。何度実行してもサーバー上のリソースの状態は変わりません。(ただし、サーバー側のログ記録や統計情報収集などの「無害な」副作用は許容されます。)
  3. 冪等 (Idempotent): 同じGETリクエストを複数回実行しても、サーバー側のリソースの状態に与える最終的な影響は同じです。一度実行した結果と、複数回実行した結果が変わらないことを保証します。
  4. キャッシュ可能: GETリクエストに対するレスポンスは、ブラウザやプロキシサーバーによってキャッシュされることがあります。これにより、同じリソースへの後続のリクエストに対して、ネットワーク通信をせずにキャッシュから応答を返すことが可能になり、表示速度の向上やサーバー負荷の軽減につながります。
  5. パラメータはURLに付加: GETリクエストでサーバーに情報を渡す場合、その情報はURLの末尾にクエリパラメータとして付加されます。?key1=value1&key2=value2 のような形式です。

これらの特徴から、GETメソッドはウェブページの表示や、APIからの情報取得(ユーザーリストの取得、特定データの参照など)に広く利用されます。一方、ユーザー登録、フォーム送信、ファイルのアップロードといった、サーバー側の状態を変更する操作には通常POSTメソッドなどが使用されます。

curlでGETリクエストを送信する

curlコマンドは、特にメソッドを指定しない場合、デフォルトでGETメソッドを使用します。そのため、前述の curl https://www.example.com/ というコマンドは、実際には GET / HTTP/1.1 というリクエストを www.example.com に対して送信しています。

基本的なGETリクエストの実行

最も基本的なGETリクエストは、単に取得したいリソースのURLを指定するだけです。

bash
curl https://www.example.com/

このコマンドは、https://www.example.com/ のトップページのHTMLコンテンツを取得し、標準出力(通常はターミナル)に表示します。

レスポンスの詳細を確認する (-v オプション)

curlコマンドはデフォルトでは取得したレスポンスボディ(HTMLなど)のみを表示しますが、通信の過程で何が起こっているのか、どのようなリクエストヘッダーが送信され、どのようなレスポンスヘッダーが返ってきたのかを知りたい場合があります。そのような時に役立つのが -v (verbose) オプションです。

bash
curl -v https://www.example.com/

このコマンドを実行すると、リクエストとレスポンスの詳細な情報が表示されます。出力は以下のようになります(内容はアクセスするサイトやcurlのバージョンによって異なります)。

“`
* Trying 93.184.216.34:443… <– 接続先のIPアドレスとポート
* Connected to www.example.com (93.184.216.34) port 443 (#0) <– 接続成功
* ALPN: offers h2,http/1.1 <– 使用可能なプロトコルの提示 (HTTP/2, HTTP/1.1)
* TLSv1.3 (IN), TLS handshake, Client hello (1): <– TLSハンドシェイク開始
… (TLSに関する詳細なやり取り) …
* TLSv1.3 (OUT), TLS handshake, Finished (20):
* SSL connection successfully established to www.example.com (93.184.216.34) <– SSL/TLS接続確立
* Using HTTP/1.1 <– 最終的に使用するHTTPバージョン

GET / HTTP/1.1 <– 送信するリクエストライン(メソッド, パス, HTTPバージョン)
Host: www.example.com <– リクエストヘッダー:Host
User-Agent: curl/7.81.0 <– リクエストヘッダー:User-Agent (使用しているcurlのバージョンなど)
Accept: / <– リクエストヘッダー:Accept (受け入れ可能なメディアタイプ)
<– リクエストヘッダーの終わりを示す空行
* Mark non-timed-out as read
< HTTP/1.1 200 OK <– レスポンスライン(HTTPバージョン, ステータスコード, ステータステキスト)
< Cache-Control: max-age=604800 <– レスポンスヘッダー
< Content-Type: text/html <– レスポンスヘッダー (返されるデータの種類)
< Date: Tue, 24 Oct 2023 01:00:00 GMT <– レスポンスヘッダー
< Etag: “3147526947+ident” <– レスポンスヘッダー
< Expires: Tue, 31 Oct 2023 01:00:00 GMT <– レスポンスヘッダー
< Last-Modified: Thu, 17 Oct 2019 07:18:26 GMT <– レスポンスヘッダー
< Server: ECS <– レスポンスヘッダー (使用されているウェブサーバー)
< Vary: Accept-Encoding <– レスポンスヘッダー
< Content-Length: 1256 <– レスポンスヘッダー (ボディのサイズ)
< <– レスポンスヘッダーの終わりを示す空行
{ [1256 bytes data] <– レスポンスボディの始まりを示すメッセージ

                  <-- ここからレスポンスボディ (HTMLコンテンツ)



Example Domain
… (省略) …

  • Connection #0 to host www.example.com left intact <– 接続が維持されたことを示すメッセージ
    “`

-v オプションの出力に含まれる主要な部分を解説します。

  • * で始まる行: 接続やSSL/TLSハンドシェイクなど、通信の過程に関する情報です。
  • > で始まる行: クライアント(curl)からサーバーへ送信されるリクエスト情報です。
    • GET / HTTP/1.1: これはリクエストラインと呼ばれ、メソッド(GET)、リソースのパス(/ はルートパス)、使用するHTTPバージョン(HTTP/1.1)を示しています。
    • 続く行はリクエストヘッダーです。Host, User-Agent, Accept などが含まれます。これらのヘッダーは、サーバーに対してリクエストに関する追加情報(どのホスト宛てか、どのクライアントからか、どのようなレスポンスを期待するかなど)を伝えます。
  • < で始まる行: サーバーからクライアント(curl)へ返されるレスポンス情報です。
    • HTTP/1.1 200 OK: これはレスポンスラインと呼ばれ、使用されたHTTPバージョン、ステータスコード(200)、ステータステキスト(OK)を示しています。ステータスコードは、リクエストの結果がどうなったかを表す3桁の数字です。200 OK は「リクエストは成功し、要求されたリソースがレスポンスボディに含まれています」という意味です。
    • 続く行はレスポンスヘッダーです。Content-Type, Content-Length, Date, Server などが含まれます。これらのヘッダーは、レスポンスに関する追加情報(レスポンスボディのタイプ、サイズ、日付、サーバーソフトウェアなど)をクライアントに伝えます。
  • { または } で囲まれた部分: レスポンスボディの始まりと終わりを示します。通常、ここに取得したリソースの本体(HTML、JSON、画像データなど)が表示されます。

-v オプションは、curlを使ったHTTP通信のデバッグにおいて非常に強力なツールです。リクエストやレスポンスの詳細を確認することで、問題の原因を特定しやすくなります。

GETリクエストにパラメータを付加する

GETメソッドは、サーバーに情報を渡すためにURLクエリパラメータを使用します。これは、URLのパス部分の後に ? を付け、その後に キー=値 のペアを & で区切って連結する形式です。

例: https://example.com/search?query=curl&category=tools

ここでは、search というパスに対して、query という名前で値が curlcategory という名前で値が tools という2つのパラメータを渡しています。

curlコマンドでこのようなGETリクエストを送信するには、単純にパラメータを含んだURLを指定します。

bash
curl "https://example.com/search?query=curl&category=tools"

注意点: URLに & などの特殊文字が含まれる場合、シェルの解釈を防ぐためにURL全体をダブルクォーテーション (") またはシングルクォーテーション (') で囲むのが安全です。シングルクォーテーションはほとんどのシェルで特殊文字を完全に無効化しますが、ダブルクォーテーションは変数展開などは行います。URLの場合は、通常ダブルクォーテーションで十分です。

URLエンコーディング

URLクエリパラメータの値には、英数字、一部の記号(-, _, ., ~ など)のみがそのまま使用できます。スペースや日本語、&, =, ?, /, #, + などの特殊文字や予約文字は、URLエンコーディング(パーセントエンコーディングとも呼ばれる)を行う必要があります。URLエンコーディングでは、これらの文字を %XX という形式で表現します(XXはその文字のASCIIまたはUTF-8コードポイントの16進数表現)。例えば、スペースは %20&%26、日本語の「テスト」は %E3%83%86%E3%82%B9%E3%83%88 のようになります。

ほとんどの場合、URLに含まれるパラメータは既に適切にエンコードされているはずです。しかし、自分でURLを組み立てる場合や、プログラムの出力などを受け取る場合は、エンコーディングが必要かどうか注意する必要があります。

curl自体は、コマンドラインで指定されたURLに対して基本的なURLエンコーディングを自動的に行うわけではありません。したがって、パラメータに特殊文字や日本語を含める場合は、事前に手動またはスクリプトでエンコードしておくのが最も確実な方法です。

例:パラメータ query に「C++ & Python」という文字列を渡したい場合

手動エンコーディングが必要: 「C++ & Python」 -> C%2B%2B%20%26%20Python

bash
curl "https://example.com/search?query=C%2B%2B%20%26%20Python"

curlには --data-urlencode オプションがありますが、これは主にPOSTリクエストでフォームデータをURLエンコードして送信するために使われます。GETリクエストのクエリパラメータに対して使うのは一般的ではなく、URL自体に含めるのが標準的な方法です。

具体的なAPI呼び出し例

天気予報APIなど、多くのWeb APIはGETリクエストとURLクエリパラメータを使用して情報を提供しています。例えば、ある架空の天気予報APIが、都市名と国名をパラメータとして受け取り、その都市の現在の天気予報をJSON形式で返す場合を考えます。APIのエンドポイントが https://api.weather.example.com/current で、パラメータが citycountry だとします。

“`bash

例: 東京、日本の天気を取得

curl “https://api.weather.example.com/current?city=Tokyo&country=Japan”
“`

このコマンドは、指定された都市と国の天気情報をサーバーにリクエストします。サーバーは通常、JSONやXMLなどの形式で天気データをレスポンスボディとして返します。

パラメータの値にスペースが含まれる場合(例: New York):

“`bash

例: New York, USA の天気を取得

パラメータの値 “New York” のスペースを %20 にエンコードする

curl “https://api.weather.example.com/current?city=New%20York&country=USA”
“`

このように、GETリクエストのパラメータはURLの一部として指定し、必要に応じてURLエンコーディングを行うことで、様々な種類の情報をサーバーに渡すことができます。

レスポンスデータの扱い

curlコマンドでGETリクエストを実行すると、通常は取得したレスポンスボディが標準出力に表示されます。しかし、取得したデータをファイルに保存したり、ヘッダー情報だけを取得したりしたい場合もあります。

標準出力への表示

これがデフォルトの動作です。ウェブページのHTML、APIからのJSON/XMLデータ、テキストファイルの内容などがターミナルに表示されます。

bash
curl https://jsonplaceholder.typicode.com/posts/1

これは、テスト用のダミーAPIからIDが1の投稿データをJSON形式で取得する例です。取得したJSONデータがターミナルに表示されます。

json
{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et ...\n..."
}

ファイルへの保存 (-o オプション)

取得したデータをファイルに保存したい場合は、-o (output) オプションを使用します。

bash
curl -o index.html https://www.example.com/

このコマンドは、https://www.example.com/ のトップページのHTMLコンテンツを取得し、標準出力に表示する代わりに、現在のディレクトリに index.html という名前のファイルとして保存します。

ファイル名をURLから自動的に決定したい場合は、-O (remote-name) オプションを使用します。これは、URLの最後のスラッシュ以降の部分をファイル名として利用します。

bash
curl -O https://www.example.com/images/logo.png

このコマンドは、https://www.example.com/images/logo.png の画像ファイルを取得し、自動的に logo.png という名前で現在のディレクトリに保存します。

ヘッダー情報のみ取得 (-I オプション)

レスポンスボディを取得せず、ヘッダー情報のみを確認したい場合は、-I (head) オプションを使用します。これは、内部的にGETメソッドではなくHEADメソッドを使用してリクエストを送信します。HEADメソッドはGETメソッドと全く同じヘッダーを返しますが、ボディは含みません。これは、ファイルサイズや更新日時、Content-Typeなどを素早く確認したい場合に便利です。

bash
curl -I https://www.example.com/

出力例:

HTTP/1.1 200 OK
Cache-Control: max-age=604800
Content-Type: text/html
Date: Tue, 24 Oct 2023 01:00:00 GMT
Etag: "3147526947+ident"
Expires: Tue, 31 Oct 2023 01:00:00 GMT
Last-Modified: Thu, 17 Oct 2019 07:18:26 GMT
Server: ECS
Vary: Accept-Encoding
Content-Length: 1256

ボディ情報のみ取得 (-s オプションなど)

デフォルトではボディが表示されますが、-v オプションを使うと詳細な情報(接続情報、ヘッダーなど)も表示されてしまいます。純粋にレスポンスボディだけを表示させたい場合は、-s (silent) オプションを使用して進行状況メーターやエラーメッセージ以外の出力を抑制し、-o-O を使わなければ、ボディが標準出力に表示されます。

bash
curl -s https://www.example.com/

このコマンドは、プログレスメーターなどの余分な表示なしに、https://www.example.com/ のHTMLコンテンツのみを標準出力に表示します。エラーが発生した場合も、-s オプションがあるとエラーメッセージが表示されないことがあるため、通常は -S (show-error) オプションと組み合わせて使用することが推奨されます。

bash
curl -sS https://www.example.com/

これで、成功時はボディのみ、エラー発生時はエラーメッセージが表示されます。

HTTPヘッダーの操作

HTTPヘッダーは、リクエストやレスポンスに関する付加的な情報を提供します。クライアントはリクエストヘッダーを使ってサーバーに情報を伝え、サーバーはレスポンスヘッダーを使ってクライアントに情報を伝えます。GETリクエストにおいても、ヘッダーは重要な役割を果たします。例えば、クライアントがどのような形式のデータを求めているか (Accept)、どのブラウザ/ツールを使用しているか (User-Agent)、キャッシュに関する情報 (If-Modified-Since, If-None-Match) などをヘッダーで伝えます。

ヘッダーを指定する (-H オプション)

curlコマンドでリクエストヘッダーを追加または上書きするには、-H (header) オプションを使用します。このオプションは複数回指定できます。

構文: -H "Header-Name: Header Value"

例: User-Agent ヘッダーをカスタム値に設定する

bash
curl -H "User-Agent: MyCustomClient/1.0" https://www.example.com/

このリクエストは、デフォルトのcurlのUser-Agentではなく、「MyCustomClient/1.0」という値を持つUser-Agentヘッダーをサーバーに送信します。

例: Accept ヘッダーを指定して、応答としてJSON形式のデータを要求する(APIなどに対して)

bash
curl -H "Accept: application/json" https://api.example.com/data

これにより、サーバーに対して「レスポンスボディはJSON形式で欲しい」という意図を伝えます。サーバーが複数の形式に対応している場合、このヘッダーを見て適切な形式でデータを返すことがあります。

例: 複数のヘッダーを指定する

bash
curl -H "User-Agent: MyClient/1.0" -H "Accept-Language: ja-JP,en-US;q=0.7" https://www.example.com/

これで、User-AgentとAccept-Language(優先する言語)の2つのヘッダーを同時に設定してリクエストを送信できます。

APIキーや認証情報をヘッダーに含める

多くのWeb APIでは、認証や認可のためにAPIキーやトークンをリクエストヘッダーに含めることが一般的です。GETリクエストでも同様です。

例: X-API-Key ヘッダーにAPIキーを含める

bash
curl -H "X-API-Key: YOUR_API_KEY_HERE" https://api.example.com/secured/data

例: Bearerトークンを Authorization ヘッダーに含める

bash
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.example.com/protected/resource

ヘッダーの値にスペースや特殊文字が含まれる場合は、全体をクォーテーションで囲むことを忘れないでください。

既存のヘッダーを上書きまたは削除する

-H "Header-Name:" のように、ヘッダー名の後にコロンだけを付けて値を空にすることで、そのヘッダーをリクエストから削除できます(または空の値で送信します)。

“`bash

デフォルトのUser-Agentヘッダーを削除してリクエストを送信

curl -H “User-Agent:” https://www.example.com/ -v
“`

-v オプションと組み合わせて実行すると、送信されるリクエストヘッダーにUser-Agentが含まれていない(または空になっている)ことが確認できます。

GETリクエストにおけるヘッダー操作は、APIへのアクセス制御、コンテンツネゴシエーション、キャッシュ制御など、様々な高度なシナリオで不可欠となります。

リダイレクトの扱い

ウェブサイトにアクセスした際に、自動的に別のURLへ転送されることがあります。これをHTTPリダイレクトと呼びます。HTTPのステータスコードが3xx(例: 301 Moved Permanently, 302 Found, 307 Temporary Redirect)の場合、それはリダイレクトを示しています。

curlコマンドは、デフォルトではリダイレクトを自動的に追跡しません。リダイレクトレスポンスを受け取ると、そのレスポンス(3xxステータスコードとLocationヘッダー)を表示して終了します。

“`bash

リダイレクト設定されているURLにアクセス (例: http://example.com は http://www.example.com にリダイレクトされることが多い)

curl http://example.com/ -v
“`

-v オプション付きで実行すると、以下のようなレスポンスヘッダーが表示されるはずです。

< HTTP/1.1 301 Moved Permanently
< Location: http://www.example.com/ <-- リダイレクト先のURL
< Content-type: text/html
... (その他のヘッダー) ...

ステータスコードが 301 Moved Permanently で、Location ヘッダーに新しいURLが指定されています。curlはここで停止し、リダイレクト先の http://www.example.com/ へは自動的にアクセスしません。

リダイレクトを追跡する (-L オプション)

curlにリダイレクトを自動的に追跡させたい場合は、-L (location) オプションを使用します。

bash
curl -L http://example.com/

このコマンドは、http://example.com/ にアクセスし、リダイレクトレスポンスを受け取ると、Location ヘッダーで指定されたURL(この例では http://www.example.com/)に自動的に再度GETリクエストを送信し、最終的なレスポンスボディを取得します。

-L オプションは、短縮URLの展開や、URLの古いバージョンから新しいバージョンへのアクセスなど、リダイレクトが頻繁に使用される場面で非常に便利です。

注意点: -L オプションを使用する場合、無限リダイレクトループが発生しないように注意が必要です。curlはデフォルトで最大50回のリダイレクトを追跡しますが、--max-redirs オプションでこの制限を変更できます。

認証が必要なGETリクエスト

リソースを取得するために認証が必要な場合があります。HTTP認証にはいくつかの種類がありますが、ここではよく使われるベーシック認証とトークン認証について、curlでのGETリクエストにおける扱い方を説明します。

ベーシック認証 (-u オプション)

HTTPベーシック認証は、ユーザー名とパスワードをBase64エンコードして、Authorization ヘッダーに含めて送信するシンプルな認証方式です。

curlでベーシック認証を行うには、-u (user) オプションを使用します。

構文: -u "username:password"

bash
curl -u "myuser:mypassword" https://protected.example.com/resource

このコマンドは、https://protected.example.com/resource に対してGETリクエストを送信する際に、Authorization: Basic base64_encoded_credentials という形式のヘッダーを自動的に付加します。例えば、myuser:mypassword はBase64エンコードされて bXl1c2VyOm15cGFzc3dvcmQ= となり、ヘッダーは Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ= となります。

パスワードに : が含まれる場合など、複雑なパスワードを指定する際は、パスワード部分をURLエンコードする必要がある場合があります。あるいは、-u "username" のようにユーザー名だけを指定し、パスワードはインタラクティブに入力を求められるようにすることも可能です。

セキュリティ上の注意: ベーシック認証ではパスワードが簡単にエンコードされて送信されるため、必ずHTTPS通信(https://)と組み合わせて使用してください。HTTP(http://)で使用すると、ネットワーク上の盗聴によって容易にユーザー名とパスワードが漏洩します。

トークン認証 (Authorizationヘッダー)

API認証で最も一般的なのは、APIキーやOAuth2などの認証フローで取得したアクセストークンをリクエストヘッダーに含める方法です。これは通常、Authorization: Bearer <token> の形式で行われます。

この形式の認証を行うには、前述の -H オプションを使用します。

bash
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN_HERE" https://api.example.com/protected/resource

この方法も、トークンが傍受されないよう、必ずHTTPS通信と組み合わせて使用してください。

SSL/TLSと証明書

現代のウェブ通信では、セキュリティのためHTTPSが広く利用されています。HTTPSはHTTPの上にSSL/TLSプロトコルを重ねることで、通信内容を暗号化し、データの盗聴や改ざんを防ぎます。

curlはHTTPS通信をサポートしており、URLが https:// で始まる場合に自動的にSSL/TLS接続を試みます。接続時には、サーバーから送られてくるSSL/TLS証明書を検証し、その証明書が信頼できる認証局(CA)によって発行されており、かつ証明書の対象ホスト名がアクセスしようとしているホスト名と一致するかなどを確認します。

自己署名証明書や無効な証明書への対応 (-k オプション)

SSL/TLS証明書の検証に失敗した場合(例えば、自己署名証明書を使用している開発環境や、証明書の期限切れなど)、curlはデフォルトで接続を拒否し、エラーメッセージを表示します。

“`bash

無効な証明書を持つサイトへのアクセスを試みる(エラーになる)

curl https://self-signed.example.com/
“`

出力例:

curl: (60) SSL certificate problem: self signed certificate
More details here: https://curl.se/docs/sslcerts.html

開発環境でのテストなど、特定の状況で証明書の検証をスキップしたい場合は、-k (insecure) または --insecure オプションを使用できます。

“`bash

証明書検証をスキップしてアクセス (非推奨)

curl -k https://self-signed.example.com/
“`

警告: -k オプションはセキュリティ上のリスクを伴います。このオプションを使用すると、サーバーのなりすましを検出できなくなるため、本番環境や信頼できないネットワークでの使用は絶対に避けてください。あくまで一時的なデバッグや、自己署名証明書を使用している特定の開発環境でのみ限定的に使用すべきです。

クライアント証明書の使用

サーバーがクライアント証明書を要求する場合、curlはクライアント証明書を指定してリクエストを送信することも可能です。これは、特定のAPIやサービスへのアクセスにおいて、追加のセキュリティ層を提供するために使用されます。

クライアント証明書と秘密鍵を指定するには、--cert および --key オプションを使用します。

bash
curl --cert client.crt --key client.key https://api.example.com/secure

タイムアウトとエラーハンドリング

ネットワークの遅延やサーバーの応答がない場合、curlコマンドがいつまでも終了しないといった状況が発生する可能性があります。このような問題を回避するために、curlにはタイムアウトを設定するオプションが用意されています。

接続タイムアウト (–connect-timeout)

サーバーへのTCP接続が確立されるまでの最大時間を秒数で指定します。指定した時間内に接続できない場合、curlはエラーとなります。

“`bash

接続確立まで最大5秒待つ

curl –connect-timeout 5 https://slow-server.example.com/
“`

操作タイムアウト (–max-time)

リクエスト全体の処理(接続、リクエスト送信、レスポンス受信)にかかる最大時間を秒数で指定します。指定した時間内に操作が完了しない場合、curlはエラーとなります。

“`bash

操作全体で最大10秒待つ

curl –max-time 10 https://very-slow-api.example.com/
“`

エラー発生時の挙動とステータスコード

curlコマンドがエラーで終了した場合、通常は非ゼロの終了ステータスコードを返します。成功した場合はゼロを返します。これは、シェルスクリプトなどでcurlの実行結果をチェックする際に重要です。

また、HTTPリクエストが成功しても、サーバーからの応答がエラーを示すステータスコード(4xx クライアントエラー、5xx サーバーエラーなど)である場合があります。これらのHTTPステータスコードは、curl自体がエラーと判断するものではありませんが、取得したレスポンスボディやヘッダー(-v オプションで確認)で確認できます。

例えば、存在しないページにアクセスした場合、サーバーは通常404 Not Foundを返します。

bash
curl -v https://www.example.com/nonexistent_page

出力の一部:

< HTTP/1.1 404 Not Found
< Content-Type: text/html
... (その他のヘッダー) ...

この場合、curlコマンド自体の終了ステータスはゼロ(成功)ですが、HTTPステータスコードは404(エラー)です。curlに特定のHTTPステータスコードでエラーとするように指示するには、--fail オプションを使用します。

“`bash

400以上のステータスコードでエラーとする

curl –fail https://www.example.com/nonexistent_page
“`

このコマンドは、404レスポンスを受け取ると、curlのエラーとして終了し、非ゼロの終了ステータスを返します。これは、スクリプトでAPIの呼び出しが成功したかを確認する際に非常に役立ちます。

GETメソッドの高度なトピック

GETメソッドは単純なデータ取得だけでなく、キャッシュ制御や部分的なコンテンツ取得といった高度な機能もサポートしています。これらはHTTPヘッダーを介して実現されます。

条件付きGET (Conditional GET)

クライアントは、特定の条件が満たされた場合にのみリソースを取得するよう要求できます。これにより、リソースが更新されていない場合に再度ダウンロードする無駄を省き、キャッシュの効率を高めることができます。これには主に2つの方法があります。

  1. If-Modified-Since ヘッダー: クライアントが最後にリソースを取得した日時を指定し、その日時以降にリソースが更新されていなければレスポンスボディを返さないようサーバーに要求します。

    “`bash

    2023年10月24日 01:00:00 GMT 以降に更新されていなければ取得しない

    curl -H “If-Modified-Since: Tue, 24 Oct 2023 01:00:00 GMT” https://www.example.com/
    “`

    リソースが指定日時以降に更新されていなかった場合、サーバーは 304 Not Modified というステータスコードで応答し、レスポンスボディは含まれません。

  2. If-None-Match ヘッダー: クライアントがキャッシュしているリソースのETag(Entity Tag、リソースの特定のバージョンを識別するユニークな文字列)を指定し、サーバー上のリソースのETagと一致すればレスポンスボディを返さないよう要求します。

    “`bash

    ETag “xyz123” と一致すれば取得しない

    curl -H “If-None-Match: \”xyz123\”” https://www.example.com/
    “`

    サーバー上のリソースのETagが指定したものと一致する場合、サーバーは 304 Not Modified で応答します。

これらのヘッダーは、以前のリクエストでレスポンスヘッダーとしてサーバーから提供された Last-ModifiedETag の値を再利用することで機能します。

部分的なコンテンツ取得 (Partial Content / Range Request)

大きなファイルの一部だけを取得したい場合や、ダウンロードが中断した箇所から再開したい場合などに、Range ヘッダーを使用してリソースの特定の範囲のみを要求できます。

“`bash

ファイルの最初の1024バイトを取得

curl -H “Range: bytes=0-1023” https://example.com/largefile.zip -o partial_file
“`

サーバーがRangeリクエストをサポートしている場合、206 Partial Content というステータスコードで応答し、指定された範囲のデータのみを返します。サポートしていない場合は、通常 200 OK で応答し、ファイル全体を返します。

HTTP/2の使用 (–http2)

より新しいHTTPバージョンであるHTTP/2は、HTTP/1.1に比べてパフォーマンスが向上しています。curlはHTTP/2もサポートしており、--http2 オプションを使用することでHTTP/2での通信を試みることができます(サーバーがHTTP/2をサポートしている必要があります)。

bash
curl --http2 https://www.example.com/

ほとんどの場合、https:// でアクセスするサイトはALPNネゴシエーションにより自動的にHTTP/2が選択されますが、明示的に指定したい場合やデバッグ目的で使用できます。

curlコマンドの応用

GETメソッドを中心としたcurlコマンドの基本的な使い方を理解したことで、様々な応用が可能になります。

シェルスクリプトでの利用

curlはコマンドラインツールであるため、シェルスクリプトに組み込んで自動化を行うのに非常に適しています。定期的なデータ取得、APIの状態監視、スクリプトからのデータ送信などに利用できます。

“`bash

!/bin/bash

API_URL=”https://api.example.com/status”
STATUS=$(curl -s –fail “$API_URL”)

if [ $? -eq 0 ]; then
echo “API Status: $STATUS”
else
echo “Error accessing API. Status code >= 400 or curl failed.”
fi
“`

この簡単なスクリプトは、--fail オプションを使用して、APIから取得したHTTPステータスコードが400以上であればcurlをエラー終了させ、その終了ステータス($? 変数に格納される)をチェックしています。-s オプションでプログレス表示を抑制し、成功した場合の標準出力(APIのステータス情報など)を変数に格納しています。

APIテストでの活用

curlは、ウェブAPIのテストにも頻繁に使用されます。パラメータを変えてリクエストを送信したり、様々なヘッダーを試したり、認証をテストしたり、レスポンスの形式や内容を確認したりと、開発中のAPIのエンドポイントを簡単に叩いて動作を確認できます。

特に、JSON形式のレスポンスを整形して見やすく表示したい場合は、jq コマンドなどのツールと組み合わせてパイプ処理を行うのが一般的です。

“`bash

APIからJSONデータを取得し、jqで整形して表示

curl -s “https://jsonplaceholder.typicode.com/posts/1” | jq .
“`

出力例:

json
{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et suscipit\nrecusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

jq . は入力されたJSONデータをそのまま整形して出力します。特定のフィールドだけを取り出すなど、jq にはさらに多くの機能があります。

デバッグツールとしての利用

前述の -v オプションに加え、curlにはデバッグに役立つ様々なオプションがあります。例えば、--trace-ascii オプションを使うと、送受信されるすべてのデータ(ヘッダー、ボディ)をファイルに記録できます。

“`bash

送受信データを trace.log ファイルに記録

curl –trace-ascii trace.log https://www.example.com/
“`

このファイルを見ると、HTTPリクエストやレスポンスの生データ、TLSハンドシェイクの詳細などが確認でき、問題の切り分けに非常に役立ちます。

まとめ

この記事では、curlコマンドを使用してGETメソッドでウェブ上のデータを取得する方法について、初心者向けに詳細な解説を行いました。

  • curlの基本: インストール方法、基本的な構文 curl [オプション] [URL]、デフォルトでGETメソッドを使用することを確認しました。
  • GETメソッドの特徴: リソース取得、安全、冪等性、キャッシュ可能、パラメータはURLに付加されるといった特性を学びました。
  • 基本的なGETリクエスト: URL指定のみでGETリクエストが送信できること、-v オプションでリクエスト/レスポンスの詳細を確認する方法を学びました。特にHTTPステータスコードやヘッダーの読み方について詳しく見ました。
  • パラメータの付加: URLクエリパラメータの形式、curlでの指定方法、URLエンコーディングの必要性について具体的な例を挙げました。
  • レスポンスデータの扱い: 標準出力への表示、-o-O オプションによるファイル保存、-I によるヘッダーのみ取得、-sS によるボディのみ表示の方法を学びました。
  • HTTPヘッダー操作: -H オプションを使ったヘッダーの追加、上書き、削除の方法を学び、APIキーや認証トークンをヘッダーに含める例を見ました。
  • リダイレクト: デフォルトでは追跡しないこと、-L オプションで自動追跡できることを学びました。
  • 認証: ベーシック認証(-u)とトークン認証(-H Authorization: Bearer ...)をGETリクエストで使用する方法を学びました。
  • SSL/TLS: HTTPS通信の基本、証明書検証、-k オプションの危険性について理解しました。
  • タイムアウトとエラーハンドリング: --connect-timeout, --max-time オプションによるタイムアウト設定、--fail オプションによるHTTPステータスコードでのエラー判定について学びました。
  • 高度なトピック: 条件付きGET (If-Modified-Since, If-None-Match)、部分的なコンテンツ取得 (Range)、HTTP/2といった発展的な内容に触れました。
  • 応用: シェルスクリプト、APIテスト、デバッグツールとしてのcurlの活用例を見ました。

curlコマンドは非常に多機能であり、ここで解説した内容はGETメソッドの基本的な側面に限られます。しかし、ウェブ上の多くの情報取得シナリオでは、この記事でカバーした内容が中心となります。

コマンドラインからHTTP通信を自在に操る能力は、現代の技術者にとって強力な武器となります。API連携の開発、ウェブサイトの運用監視、ネットワークの問題診断など、様々な場面でcurlコマンドが役立つでしょう。

ぜひ、この記事で学んだことを活かして、実際に様々なURLに対してcurlコマンドを実行し、その挙動を観察してみてください。オプションを組み合わせたり、普段アクセスしているウェブサイトやサービスのAPI(公開されているもの)を試してみることで、さらに理解が深まるはずです。

curlコマンドのさらなる機能(POSTメソッド、プロキシ設定、クッキーの扱いなど)については、公式ドキュメントや他の資料を参照しながら、必要に応じて学習を進めていくことをお勧めします。

Happy curling!

参考文献 / リソース


コメントする

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

上部へスクロール