如何使用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.其他查看插件文檔面板


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM