REST APIをオンラインでテストする方法：何もインストールせずに

「APIのテスト」が実際に意味すること

REST APIをテストするとは、エンドポイントにHTTPリクエストを送信して返ってきた内容 — ステータスコード、ヘッダー、ボディ — を検査することです。エンドポイントが正常に動作することを確認したり、返されるデータの正確な構造を確認したり、バグを再現したり、コードを書く前にサードパーティAPIを探索したりするために行います。リクエストを送信してレスポンスを読む速度が速いほど、APIを素早く理解できます。

このためのデスクトップツールも存在しますが、簡単な確認には大げさすぎます。ブラウザベースのテスターは即座に読み込まれ、インストール、アカウント、セットアップなしで日常的なリクエストの大部分を処理できます。

RESTリクエストの構成要素

• メソッド — GETはデータを取得し、POSTは作成し、PUTとPATCHは更新し、DELETEは削除します。メソッドはサーバーに意図を伝えます。
• URL — エンドポイントのアドレス。?page=2&limit=20のようなクエリパラメーターを含むこともあります。
• ヘッダー — リクエストに関するメタデータ：Content-Typeはボディの形式を説明し、Authorizationは認証情報を含み、Acceptは希望するレスポンス形式を指定します。
• ボディ — POST、PUT、またはPATCHで送信されるペイロード。通常はJSONです。GETとDELETEには通常ボディはありません。

レスポンスの読み方

すべてのレスポンスには、何が起きたかをひと目で示すステータスコードが含まれています。ファミリーは覚えやすいです：2xxは成功（200 OK、201 Created）、3xxはリダイレクト、4xxはクライアントのミス（404 Not Found、401 Unauthorized、400 Bad Request）、5xxはサーバーの失敗（500 Internal Server Error）です。APIの呼び出しが期待通りに動作しない場合、ステータスコードが最初の手がかりになります。

ステータスの下には、ペイロードを説明するレスポンスヘッダーがあり、ボディには実際のデータが含まれています。JSONを自動的に整形するテスターは、ボディを1行の密なテキストではなく読みやすい形式にしてくれます。

典型的なテストワークフロー

• GETから始める — エンドポイントが到達可能であることを確認し、他のことをする前にレスポンスの形を確認します。
• 認証を追加する — 多くのエンドポイントではAuthorizationヘッダー（多くの場合ベアラートークン）が必要です。401レスポンスはほぼ常に、これが欠落しているか間違っていることを意味します。
• JSONボディを持つPOSTを送信する — Content-Type: application/jsonを設定し、201レスポンスとレスポンス内の作成されたリソースを確認します。
• バグを再現する — エンドポイントが予期せぬ動作をする場合、アプリケーションログから推測するのではなく、まったく同じリクエストを再送してステータスとボディを読みます。

よくある問題点

ほとんどの失敗したリクエストは少数の原因に起因します：欠落しているか不正な形式のContent-Typeヘッダー、有効期限切れまたは不在の認証トークン、URLのタイポや間違ったクエリパラメーター、またはボディの不正なJSONです。テスターは生のステータスとレスポンスを表示するため、これらを素早く診断できます — APIはその返答を明確に読めさえすれば何が問題か教えてくれます。

最初のリクエストを今すぐ送信する

無料のオンラインREST APIテスターを開く — メソッドを選択し、ヘッダーとボディを設定し、リクエストを送信して、ステータスコードとともに整形されたレスポンスを確認します。サインアップ不要、インストール不要。