REST Clientの使い方 - VSCodeで簡単にAPIリクエスト

概要#

REST Client は Visual Studio Code 上で HTTP リクエストを送信し、レスポンスを直接確認できる拡張機能です。
API 開発や検証を VSCode 内で完結させることができます。

導入#

VSCode の拡張機能一覧から REST Client をインストール
拡張子 .http または .rest のファイルを作成

基本的な使用方法#

GET リクエスト#

作成したファイルに以下のように記述し、Send Request リンクをクリックしてリクエストを送信します。

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

GETリクエスト

POST リクエスト#

POST リクエストも同様に記述できます。
データは JSON 形式で送信することができます。

1
POST https://jsonplaceholder.typicode.com/posts
2
Content-Type: application/json
3

4
{
5
  "title": "foo",
6
  "body": "bar",
7
  "userId": 1
8
}

POSTリクエスト

複数リクエスト#

1つのファイルに複数のリクエストを定義することも可能です。 ### で区切ることで、1ファイル内に複数のリクエストを定義できます。

1
### GET
2
GET https://jsonplaceholder.typicode.com/posts/1
3

4
### POST
5
POST https://jsonplaceholder.typicode.com/posts
6
Content-Type: application/json
7

8
{
9
  "title": "bar",
10
  "body": "baz",
11
  "userId": 2
12
}

複数リクエストがある場合、Send Request リンクがそれぞれのリクエストごとに表示されます。

複数リクエスト

CAUTION
### を使わずにリクエストを連続して書いた場合、 Send Request リンクが1つしか表示されません
1
GET https://jsonplaceholder.typicode.com/posts/1
2

3
POST https://jsonplaceholder.typicode.com/posts
4
Content-Type: application/json
5

6
{
7
  "title": "bar",
8
  "body": "baz",
9
  "userId": 2
10
}

変数の利用#

環境ごとに異なる URL やトークンを変数として定義し、使い回すことができます。

定義

1
@baseUrl = https://jsonplaceholder.typicode.com
2
@userId = 1

利用

1
GET {{baseUrl}}/posts/{{userId}}

1
@baseUrl = https://jsonplaceholder.typicode.com
2
@userId = 1
3

4
### GET
5
GET {{baseUrl}}/posts/{{userId}}
6

7
### POST
8
POST {{baseUrl}}/posts
9
Content-Type: application/json
10

11
{
12
  "title": "bar",
13
  "body": "baz",
14
  "userId": 2
15
}

変数の利用

認証付きリクエスト#

認証が必要な API も簡単にリクエストを送信できます。

Bearer Token#

1
@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
2

3
GET https://api.example.com/users/me
4
Authorization: Bearer {{token}}

利用シーン#

API 開発中の動作確認
外部 API の動作検証
ドキュメントに記載された API の動作確認

補足#

本記事では、サンプル用に JSONPlaceholderを利用しています。
JSONPlaceholder はモック API サービスで、GET/POST/PUT/DELETE などの HTTP リクエストを試すことができます。