WebAPIやWebアプリケーションを作ったときに,その動作を確認するためにリクエストを送りたい時がある.

Webアプリケーションであれば,アプリを動かして操作して確かめることもできるが,WebAPIだとリクエストをぽいっと送れるととても便利です.

HTTPリクエストを送るツールは色々あるようで,コマンドラインだとCurlとか.

こんなとき,VS CodeがRESTクライアントになるので便利.

拡張機能をインストールする

marketplace.visualstudio.com

ファイルを作成し,名前を◯◯.httpとする.

拡張子が.httpの場合に,この拡張機能が動作する.

VS Codeでファイルに以下のように書く.

# ホストのURL
@host = http://localhost:56598

###
GET {{host}}/api/todo-items
Accept: application/json

###
GET {{host}}/api/todo-items/0
Accept: application/json

しばらくすると,｢Send Request｣と表示されるので,それをクリックすると指定したサーバーに対してHTTPリクエストが送られる.

f:id:shuhelohelo:20191030203410p:plain

VS Codeに新しいタブが表示されてレスポンスが表示される(あれば).

f:id:shuhelohelo:20191030203522p:plain

注意すべきところは,###は決して飾りではないということ.

リクエストを示すマーク.

POSTの書き方は以下のとおり.

呼び出すWebAPIが上の例とは異なるけれど,こんな感じ.

###
POST {{host}}/authors
Content-Type: application/json

{
    "FirstName":"Foo",
    "LastName":"Bar",
    "Nationality":"Al"
}

注意が必要なのは,Content-Type:application/jsonとpostするjsonの間に空行が必要だということ.これが無いとエラーになる.

f:id:shuhelohelo:20191225213202p:plain

Postするデータの開始がわからないから,ということなのかな.

検索用タグ

Rest Client RestClient