自從遇到 REST Client for VS Code API測試工具後,就跟 Postman 說掰掰了
REST Client 使用文字腳本方式正合我意,因為要把測試腳本傳給同事
直接複製貼上就可以非常快速分享給其他人
甚至因為是文字腳本,可以上Git版本控制,跟其他夥伴共同維護腳本 (這一點相信 Postman 就沒辦法做到)
撰寫測試腳本非常直覺,而且可以定義共用變數,且API Respond參數可以傳遞給其他測試請求
大部分的API測試情境都可以滿足,這邊簡單列一下常用的情境和使用方式
REST-Client 副檔名為 .http 或 .rest
簡單的動態變數
- 產生GUID {{$guid}}
- 亂數產生 5~200數值 {{$randomInt 5 200}}
- 現在UTC時間戳 {{$timestamp}}
- 3小時前UTC時間戳 {{$timestamp -3 h}}
JWT Authorization Token 參數傳遞 範例
@url = http://127.0.0.1 ### 登入 # @name login POST {{url}}/api/Login Content-Type: application/json Lang: zh-cn { "account": "nelson", "password": "123" } ### 資料用戶資料 POST {{url}}/api/GetUser Content-Type: application/json Authorization: Bearer {{login.response.body.$.Data.Token}} Lang: zh-cn { "abc": 1, "type": 2 }
GET 範例
GET http://127.0.0.1/order?id=abc12345
POST Application/x-www-form-urlencoded 範例
POST http://127.0.0.1/api/pay HTTP/1.1 Content-Type: application/x-www-form-urlencoded money=101.0 &order=abc12345 &ip=127.0.0.1
POST Application/json 範例
POST http://127.0.0.1/api/pay HTTP/1.1 Content-Type: application/json { "money": 101.0, "order": "abc12345", "ip": "127.0.0.1" }
更多範例與說明可參考GitHub https://github.com/Huachao/vscode-restclient
已知問題
使用到現在遇到若 REST Client Response Body Size過大
會導致REST Client Response預覽區顯示一片空白,甚至會VS Code會閃退
但如果電腦記憶體夠大REST Response 預覽區還是會顯示