はじめに
今回はVSCode（Visual Studio Code）の拡張機能である「REST Client」を使用して、APIのリクエストを簡単に実行する方法について紹介します。
REST Client拡張機能のインストール
VSCodeにREST Client拡張機能をインストールします。
- VSCodeを開きます。
- 左側のアクティビティバーから「拡張機能」を選択します。
- 検索バーで「REST Client」を探して、インストールボタンをクリックします。
HTTPファイルの作成
REST Clientは、.httpか.restの拡張子で保存されたファイルで実行できます。
ファイルを作成し、HTTPリクエストを記述していきます。
1つのファイルに複数のリクエストを記述する場合は、###で区切ります。
リクエストヘッダとリクエストボディの間は１行空ける必要があります。
test.http
### GET Request
GET https://api.example.com/users
### POST Request
POST https://api.example.com/users
Content-Type: application/json
{
"name": "John Brown",
"email": "john.brown@example.com"
}
リクエストの実行
作成したHTTPファイルを開き、各リクエストの上部に表示される「Send Request」のリンクをクリックすると、HTTPリクエストが実行され、右側にレスポンスが表示されます。
色々なリクエストの記述例
リクエストボディを別ファイルに記述する
リクエストボディを別ファイルに記述して読み込ませることが可能です。
POST https://api.example.com/xxxxx
Content-Type: application/json
< ./test.json
Basic認証で接続する
Basic認証で接続する場合の記述例です。
BASE64_USER_PASSの部分に"username:password"をBase64でエンコードした文字列を入れます。
GET https://api.example.com/xxxxx
Authorization: Basic BASE64_USER_PASS
変数を使用する
変数を使用する場合は、@変数名 = 値という形式で定義します。
定義した変数は、{{変数名}}の形式でリクエスト内で使用できます。
@base_url = https://api.example.com
### GET Request
GET {{base_url}}/users
### POST Request
POST {{base_url}}/users
Content-Type: application/json
{
"name": "John Brown",
"email": "john.brown@example.com"
}
まとめ
REST Clientを使用することで、APIのテストが簡単に実行できる様になりました。
ご興味のある方は、是非お試しください。
Discussion