概要
APIのリクエストレスポンスの確認としてPostmanを使っているが、
Visual Studio Code(VSCode)の拡張機能であるREST Clientが便利だったので
使い方のメモを記載する。
手順
1.REST Clientのインストール
拡張機能の検索から「REST」入力すると一番上に表示される。
インストールボタンを押してREST Clientの拡張機能を取り込む
2.REST Clientを使ったGETリクエスト
リクエスト操作を行うために、.httpファイルを作成する。
本記事では、sample.httpファイルを用意し、記載をしていく。
sample.http
GET http://localhost:3000/api/v1/tasks HTTP/1.1
たまたまローカル環境に、Rails APIで起動しているアプリがあったので、GETリクエストをする。
リクエストURLを記載し、上に書かれた「Send Request」を押す。
結果
リクエストの結果として、Response画面にレスポンスデータが表示された。
3.REST Clientを使ったPOSTリクエスト
sample.httpにPost処理を記載する。
sample.https
POST http://localhost:3000/api/v1/tasks HTTP/1.1
content-type: application/json
{
"title": "sample",
"description": "これはサンプルデータです。"
}
結果
まとめ
今回のREST Clientは新くアプリをインストールすることはせずにVSCodeの拡張機能としてAPIの確認をしてみました。
拡張機能として使えるのはありがたいです。