【httpファイルってなに？】VS CodeのREST ClientでAPIを簡単テスト！
こんにちは、やまだゆうです。
今回は職場の同僚が使っていて「なんだこれ！？」と気になっていたhttpファイルについて調べて使ってみました。
スポンサーリンク
httpファイルとは
Visual Studio Code（以下、「VS Code」）の拡張機能「REST Client」で使用される拡張子です。
.httpの他に.restもサポートされているみたいです。
VS Codeで使ってみる
VS CodeのREST Clientという拡張機能を使うことで簡単にhttpファイルでAPIの動作確認ができます。
シンプルに使ってみる
zipcloudの郵便番号検索APIという無料で公開されているAPIでREST Clientを使ってみます。
postal-code.httpというファイルを作成して、以下のプログラムを書きます。
GET https://zipcloud.ibsnet.co.jp/api/search?zipcode=1000005VS Codeの画面で確認するとSend Requestというボタンが表示されるので、クリックするとResponseという分割タブが表示されて結果が確認できます。
こんな感じでVS Code上で簡単にAPIの確認ができます。
バックエンドのプログラムと同じリポジトリにテスト用のhttpファイルをまとめておけば、チームでの開発をスムーズにしてくれそうです
スポンサーリンク
ちょっとだけ応用的に使用
ここからは応用的な使い方を紹介します。
変数の使用
@をつけることで変数を使うことができます。
@postalCode = 1000005
GET https://zipcloud.ibsnet.co.jp/api/search?zipcode={{postalCode}}動的に変数を入力
リクエストの前に# @prompt 変数名を定義することでリクエスト実行時に動的に変数を設定することができます。
# @prompt postalCode
GET https://zipcloud.ibsnet.co.jp/api/search?zipcode={{postalCode}}
複数リクエストを1ファイルで管理
###を入れることで複数リクエストを1ファイルで管理することができます。
@postalCode = 1000005
@postalCodeIkebukuro = 1710022
GET https://zipcloud.ibsnet.co.jp/api/search?zipcode={{postalCode}}
###
GET https://zipcloud.ibsnet.co.jp/api/search?zipcode={{postalCodeIkebukuro}}
Send Requestをクリックすると、そのリクエストが実行されます。参考資料
- REST Client – Visual Studio Marketplace
- Huachao/vscode-restclient: REST Client Extension for Visual Studio Code
- 郵便番号検索API – zipcloud
yamaday0uを応援お願いします！あなたの１クリックが励みになります。
>> にほんブログ村