時代に翻弄されるエンジニアのブログ

ゲームプログラマをやっています。仕事やゲームや趣味に関してつらつら書きたいと思います。

vscode の REST クライアント 拡張 が便利だった

概要

  • API のクライントサイドテストを 便利にできる
  • Get や Post が実行できるのはもちろんのこと、変数保存や 呼び出し順などを定義できるため、順序的なテストができる

プラグインURL

marketplace.visualstudio.com

手順

  • 〇〇.http ファイルを作成
  • Post や Get をルールに沿って記載
    • ヘッダーやボディー部の設定が可能 例
POST https://example.com/comments HTTP/1.1
content-type: application/json

{
    "name": "sample",
    "time": "Wed, 21 Oct 2015 18:27:50 GMT"
}
  • URL の 上に Send Request ボタンを実行すると結果が別ウィンドウで返ってくる
  • レスポンスを変数に格納して次の Post に設定することなどができる
###
# @name LoginWithCustomID
POST {{baseUrl}}/Client/LoginWithCustomID
Accept-Encoding: gzip
Content-Type: application/json

{
  "CustomId": "demo",
  "CreateAccount": true,
  "TitleId": "{{titleId}}"
}

@entityToken = {{LoginWithCustomID.response.body.$.data.EntityToken.EntityToken}}
@entity = {{LoginWithCustomID.response.body.$.data.EntityToken.Entity}}

###
# @name ExecuteFunction
POST {{baseUrl}}/CloudScript/ExecuteFunction
Accept-Encoding: gzip
Content-Type: application/json
X-EntityToken: {{entityToken}}

{
  "FunctionName": "HttpSample"
}

* PlayFab の確認に使っていたので、サンプルがそれになっています

* PlayFab の クイックスタートでは .http を使った確認をしているのでかなり参考になると思います

learn.microsoft.com