【ローカルテスト効率化】REST Client拡張機能の使い方ガイド【VSCode】

この記事の最終更新日: 2025年5月12日

はじめに
1. REST Clientとは？
1. 特徴
2. インストール方法
3. 基本的な使い方
1. リクエスト作成手順
4. よく使うリクエスト例
5. 便利な活用方法
1. 複数リクエストの管理
2. 変数の利用
6. 認証の設定
1. Bearerトークンの使用例
7. レスポンスの確認と保存
8. その他の便利機能
まとめ

はじめに

Visual Studio Code（VSCode）の拡張機能「REST Client」を使うと、ブラウザやターミナルを使わず、エディタ内から直接APIリクエストを送信できます。本記事では、初めてREST Clientを使用する方にもわかりやすいように、インストール方法から基本操作、活用例まで丁寧に解説します。

1. REST Clientとは？

REST Clientは、VSCode上でHTTPリクエスト（GET、POST、PUT、DELETEなど）を直接記述・送信し、レスポンスを確認できる拡張機能です。Postmanのような外部ツールを使わずにAPIテストができ、開発効率が大幅に向上します。

特徴

エディタ内だけで完結できる
リクエスト・レスポンスをその場で確認できる
認証や変数設定なども柔軟に対応

2. インストール方法

VSCodeを開きます。
左側の拡張機能パネル（四角いアイコン）をクリックします。
検索バーに「REST Client」と入力します。
作者「Huachao Mao」のREST Clientを選択し、「インストール」ボタンを押します。

インストール後、ファイル拡張子が .http または .rest のファイルを作成すると、REST Clientが有効になります。

3. 基本的な使い方

リクエスト作成手順

.http または .rest ファイルを新規作成します。
以下のようにリクエストを記述します。

GET https://jsonplaceholder.typicode.com/posts/1

リクエスト行の上に「Send Request」と表示されるのでクリックします。
右側にレスポンスが表示され、ステータスコード・ヘッダー・本文を確認できます。

4. よく使うリクエスト例

GETリクエスト（データ取得）

GET https://api.example.com/users

POSTリクエスト（データ登録）

POST https://api.example.com/users
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com"
}

PUTリクエスト（データ更新）

PUT https://api.example.com/users/1
Content-Type: application/json

{
  "name": "Jane Doe"
}

DELETEリクエスト（データ削除）

DELETE https://api.example.com/users/1

5. 便利な活用方法

複数リクエストの管理

リクエストとリクエストの間を ### で区切ることで、1つのファイル内に複数のリクエストを整理できます。

### ユーザー一覧取得
GET https://api.example.com/users

### 新規ユーザー作成
POST https://api.example.com/users
Content-Type: application/json

{
  "name": "New User"
}

変数の利用

よく使うURLや認証情報を変数化して管理できます。

@baseUrl = https://api.example.com

GET {{baseUrl}}/users

複雑なリクエストをシンプルにまとめることができ、メンテナンス性も向上します。

6. 認証の設定

REST Clientでは、さまざまな認証方法に対応しています。

Basic認証：ユーザー名とパスワードを使った認証
Bearerトークン：OAuth 2.0トークンを使った認証
AWS Signature v4：AWSサービス用の認証
SSLクライアント証明書：TLS/SSLを用いた認証

Bearerトークンの使用例

GET https://api.example.com/protected
Authorization: Bearer your_token_here

7. レスポンスの確認と保存

レスポンスはリクエスト直後にVSCode内に表示されます。
ステータスコード（例：200 OK）やレスポンスボディ（JSON形式など）をすぐに確認できます。
保存アイコンをクリックすれば、レスポンス内容をファイルに保存することも可能です。

8. その他の便利機能

過去に送信したリクエストの履歴を参照・再実行できる
送信したリクエストをcURLコマンドに変換してコピー可能
Python、JavaScriptなど向けにコードスニペットを自動生成
GraphQLリクエストに対応
Markdownファイル内のリクエスト実行も可能

まとめ

VSCodeのREST Client拡張機能を使えば、外部ツールなしでAPI開発・テストをスムーズに進められます。シンプルなインターフェースでありながら、認証や変数管理など高度な機能も備えており、エンジニアの日常的な開発作業を大きく支援してくれるツールです。

ぜひ一度導入し、開発効率向上に役立ててみてください。

【備考情報】

REST Clientは2025年時点でもアクティブにメンテナンスされています。
最新情報については公式マーケットプレイスをご確認ください。

daigoro

大阪のエンジニアが書いているブログ。