vscode安装 REST Client 插件

1.创建一个 .http 或 .rest 文件

2.写入测试接口

符合 RFC 2616 标准的请求

  1. GET http://172.16.248.12:32407/account/is-purchased?courseProductId=1695944 HTTP/1.1
  2. content-type: application/json
  3. x-request-token: 8fd35f4a4647dca2608f99e1f948865c
  4. Accept: */*
  1. POST http://172.16.248.12:32407/credits/coupon/draw HTTP/1.1
  2. content-type: application/json
  3. x-request-token: 8fd35f4a4647dca2608f99e1f948865c
  4. Accept: */*
  6. {
  7.     "couponBaseSn": "417044078270611456"
  8. }

符合 cURL 标准的请求

  1. curl -X GET "http://172.16.248.12:32407/account/is-purchased?courseProductId=1695944" -H "accept: */*" -H "X-Request-Token: 8fd35f4a4647dca2608f99e1f948865c"
  1. curl -X POST "http://172.16.248.12:32407/credits/coupon/draw" -H "accept: */*" -H "X-Request-Token: 8fd35f4a4647dca2608f99e1f948865c" -H "Content-Type: application/json" -d "{ \"couponBaseSn\": \"417044078270611456\"}"

3.发送请求，测试接口

点击 Send Request ，或者右键选择 Send Request ，或者直接用快捷键 Ctrl+Alt+R（或Cmd+Alt+R） ，你的 REST API 就执行了，然后 API Response 就会显示在右边区域。

4.自定义环境变量

不同的环境（开发、测试、生产），API 接口参数可能有所不同。
点击 Code => Preferences => Settings 打开设置，切换到 Workspace Settings ，配置 settings.json 文件。

  1. {
  2.   "rest-client.environmentVariables": {
  3.     "$shared": {
  4.         "version": "v1",
  5.         "prodToken": "foo",
  6.         "nonProdToken": "bar"
  7.     },
  8.     "local": {
  9.         "version": "v2",
  10.         "host": "localhost",
  11.         "dummyhost": "local",
  12.         "token": "{{$shared nonProdToken}}",
  13.         "secretKey": "devSecret"
  14.     },
  15.     "production": {
  16.         "host": "api.apiopen.top",
  17.         "dummyhost": "dummy.restapiexample.com",
  18.         "token": "{{$shared prodToken}}",
  19.         "secretKey" : "prodSecret"
  20.     }
  21.   }
  22. }
  1. 当然，rest-client 还有更多的配置项，例如：
  2. rest-client.defaultHeaders：默认的 header 请求体，默认为 { "User-Agent": "vscode-restclient", "Accept-Encoding": "gzip" } ；
  3. rest-client.timeoutinmilliseconds：超时时长，默认为 0 ms；
  4. rest-client.previewOption：控制哪些部分应该通过rest-client预览，可选 full 、 headers 、 body 、 exchange ，默认为 full；
  5. rest-client.followredirect：是否支持 HTTP 3xx 的重定向，默认支持；

5.自定义文件变量

  2. ### 文件变量
  3. @port = 8080
  4. @contentType = application/json
  6. ### 测试接口 RFC 2616
  7. // 文件变量
  8. @name = musicRankings
  9. GET https://{{host}}/{{name}} HTTP/1.1

6.自定义请求变量

当单个请求结果的值需要被其它请求使用时，可以使用请求变量，格式为：@name newname ，请求变量引用语法为:

  1. {{requestName.(response|request).(body|headers).(JSONPath|XPath|Header Name)}}
  3. @contentType = application/json
  5. ###
  7. # @name createComment
  8. POST https://{{host}}/comments HTTP/1.1
  9. Content-Type: {{contentType}}
  11. ###
  13. # @name getCreatedComment
  15. GET https://{{host}}/comments/{{createComment.response.body.$.id}} HTTP/1.1
  17. Authorization: {{login.response.headers.X-AuthToken}}

7.系统变量

系统自带的一些变量，使用系统变量需要有 $符号

  1. {{$guid}}唯一识别号
  2. {{$randomInt min max}}返回一个min 和 max 之间的随机数
  3. {{$timestamp [offset option]}}：添加UTC时间戳。
  4. {{$timestamp number option}}，例如3小时前{{$timestamp -3 h}};代表后天{{$timestamp 2 d}}。

参考

  1. 是时候抛弃Postman了，试试 VS Code 自带神器插件👏👏👏