VSCodeのREST ClinetプラグインでRESTのテストをする方法

VSCodeのREST ClinetプラグインでRESTのテストをする方法

RESTのテストはよくPOSTMANで実施していましたが、VSCodeのREST Clientプラグインも便利です。

VSCodeのREST ClinetプラグインでRESTのテストをする方法

curlコマンドをエディターで実行してくれます。

ファイルにURLを貼り付けるだけで、ファイルの拡張子はhttpとします。

VSCodeのREST ClinetプラグインでRESTのテストをする方法

GETかPOSTを指定してからURLを指定します。HTTP1.1を指定します。

URLの上にSend Requestと表示されるのでクリックするとAPIが実行されます。

header情報を付加する場合

header情報を付加するには、URLの1行したにheader情報を追記します。

以下はAPI GatewayのAPIキー情報をヘッダに付加した例です。

POST https://example.com/v1/users HTTP/1.1
x-api-key: 99xcGdJkyi1t33J8KIscL1peEotukhjz4hhPquxx

view raw
gistfile1.txt
hosted with ❤ by GitHub

POSTでリクエストボディを設定する場合

POSTの場合はリクエストボディを送りたいと思います。

方法は以下の通り、content-type: application/jsonと記述します。

1行空けてから、JSON形式を記述します。

PUT http://localhost:8080/hoge-0.0.1-SNAPSHOT/employees/12345
Content-Type: application/json
{
"id": "12345",
"name": "takahashi"
}

view raw
gistfile1.txt
hosted with ❤ by GitHub

1ファイルで複数のテストをしたい場合

1ファイルで一つのAPIしかテストができないとなるとイケてないです。区切り文字を挿入することで複数APIのテストができます。

APIとAPIの間に###を挿入します。

POST https://example.com/v1/users HTTP/1.1
###
POST https://example.com/v2/users HTTP/1.1

view raw
gistfile1.txt
hosted with ❤ by GitHub

POSTMANと同等のことがVSCodeでできてしまいます。

  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存

コメントをどうぞ

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

CAPTCHA