欢迎加入QQ群一起探讨交流:581902292

如何使用vscode编辑器调试接口 (REST Client) ?

一般前后端调试接口都用到工具Postman,但是vscode编辑器仅需安装REST Client插件就可以调试;各有优缺点,但是REST Client插件用起来更方便。

如何快速简单操作呢?
  1.步骤一:安装 REST Client 插件
  2.步骤二:创建一个 .http 或 .rest 文件
  3.步骤三:写入测试接口
  4.步骤四:发送请求,测试接口(点击 Send Request 或者右键选择 Send Request)


  #例子:
    #符合 RFC 2616 标准的 POST 请求
    POST http://dummy.restapiexample.com/api/v1/create HTTP/1.1
    content-type: application/json
    {
      "name":"Hendry",
      "salary":"61888",
      "age":"26"
    }

    ###符合 cURL 标准的 POST 请求
    curl -X POST "http://dummy.restapiexample.com/api/v1/create" -d "Hello World"

#拓展:
  a.注意:
    (1).一个test.http文件中存在多个接口用###隔开写
    (2).如果省略 request 方法,请求将被视为 GET

  b.自定义环境变量(比如:开发、测试、生产)
    (1).vscode配置 ( Code => Preferences => Settings )
      {
        "rest-client.environmentVariables": {
          "$shared": {
            "version": "v1",
            "prodToken": "foo",
            "nonProdToken": "bar"
          },
          "local": {
            "version": "v2",
            "host": "localhost",
            "dummyhost": "local",
            "token": "{{$shared nonProdToken}}",
            "secretKey": "devSecret"
          },
          "production": {
             "host": "api.apiopen.top",
             "dummyhost": "dummy.restapiexample.com",
               "token": "{{$shared prodToken}}",
            "secretKey" : "prodSecret"
          }
        }
      }

    (2).设置完成后,可以切换不同的环境,调用相应的配置项(host 、 token 等)
      具体操作:先按下切换环境 Ctrl+Alt+E 或 Cmd+Alt+E,选择local或者production环境

      测试demo:
       ### 测试接口 RFC 2616
      // host 为环境变量
      GET https://{{host}}/musicRankings HTTP/1.1

  c.rest-client 配置项:

    rest-client.environmentVariables : 开发环境设置
    rest-client.defaultHeaders :默认的 header 请求体,默认为 { "User-Agent": "vscode-restclient", "Accept-Encoding": "gzip" } ;
    rest-client.timeoutinmilliseconds :超时时长,默认为 0 ms;
    rest-client.previewOption :控制哪些部分应该通过rest-client预览,可选 full 、 headers 、 body 、 exchange ,默认为 full ;
    rest-client.followredirect :是否支持 HTTP 3xx 的重定向,默认支持;

  d.自定义变量
   创建:@contentType = application/json
   调用:Content-Type: {{contentType}}
   系统自带的一些变量,使用系统变量需要有 $符号,例如:{{$guid}} 唯一识别号

  e.其他查看插件文档面板

posted @ 2020-02-05 14:17  £AP︶ㄣOL◢◤LO  阅读(1300)  评论(0编辑  收藏  举报