是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器!

來自:開源中國,作者:凱京技術團隊

鏈接:
https://my.oschina.net/keking/blog/3104972

  • 前言
  • 從postman到IDEA REST Client
  • IDEA REST Client控制檯
  • 歷史請求記錄
  • 構建HTTP請求腳本
  • 環境區分
  • 結果斷言
  • 結果值暫存
  • 結語
  • 前言

    接口調試是每個軟件開發從業者必不可少的一項技能,一個項目的的完成,可能接口測試調試的時間比真正開發寫代碼的時間還要多,幾乎是每個開發的日常工作項。所謂工欲善其事必先利其器,在沒有嚐到IDEA REST真香之前,postman(chrome的一款插件)確實是一個非常不錯的選擇,具有完備的REST Client功能和請求歷史記錄功能。但是當使用了IDEA REST之後,postman就可以丟了,因為,IDEA REST Client具有postman的所有功能,而且還有postman沒有的功能,繼續往下看。


    從postman到IDEA REST Client

    真香定律的原因有如下幾個:

    1. 首先postman的所有功能IDEA REST Client都具備了,如REST Client控制檯和歷史請求記錄
    2. 其次如果能夠在一個生產工具裡完成開發和調試的事情,幹嘛要切換到另一個工具呢
    3. 然後IDEA REST Client還支持環境配置區分的功能,以及接口響應斷言和腳本化處理的能力
    4. IDEA REST Client的請求配置可以用文件配置描述,所以可以跟隨項目和項目成員共享


    IDEA REST Client控制檯

    從頂層工具欄依次Tools -> HTTP Client -> Test RESTFUL Web Service 打開後,IDEA REST Client控制檯的界面如下樣式:

    是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器!

    可以看到,這個控制檯展示的功能區和postman已經沒什麼差別了,包括請求方式,請求參數和請求頭的填充都已經包含了,特別說明下的是,如果請求的方式是Authorization :Basic這種方式認證的話,可以點擊下圖所示的按鈕,會彈出填充用戶名和密碼的窗口出來,填完後會自動補充到Authorization 的header裡面去

    是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器!

    歷史請求記錄

    IntelliJ IDEA自動將最近執行的50個請求保存到http-requests-log.http 文件中,該文件存儲在項目的.idea / httpRequests / 目錄下。使用請求歷史記錄,您可以快速導航到特定響應並再次發出請求。文件內容大如下圖所示,再次發出請求只要點擊那個運行按鈕即可。如果從請求歷史記錄再次發出請求,則其執行信息和響應輸出的鏈接將添加到請求歷史記錄文件的頂部。

    是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器!

    構建HTTP請求腳本

    上面的歷史記錄就是一個完整的IDEA REST Client請求腳本,如果你是從控制檯觸發的,那麼可以直接複製歷史請求記錄的文件放到項目裡作為HTTP請求的腳本,給其他成員共享,如果不是,也可以直接新建一個.http或者.rest結尾的文件,IDEA會自動識別為HTTP請求腳本。

    語法部分

    <code>### 演示POST請求
    POST {{baseUrl}}}get?show_env=1
    Accept: application/json
    
    {
       "name":"a"
    }
    ### 演示GET請求
    
    GET {{baseUrl}}}/post
    Content-Type: application/x-www-form-urlencoded
    
    id=999&value=content/<code>


    首先通過###三個井號鍵來分開每個請求體,然後請求url和header參數是緊緊挨著的,請求參數不管是POST的body傳參還是GET的parameter傳參,都是要換行的


    環境區分

    細心的你可能發現了上面示例的代碼,沒有真實的請求地址,取而代之的,是一個{{baseUrl}}的佔位符,這個就是IDEA REST Client真香的地方,支持從指定的配置文件中獲取到環境相關的配置參數,不僅baseUrl可以通過佔位符替換,一些請求的參數如果和接口環境相關的都可以通過配置文件來區分。

    首先在.http的腳本同目錄下創建一個名為


    http-client.private.env.json的文件,然後內容如下,一級的key值時用來區分環境的,比如,dev、uat、pro等,環境下的對象就是一次HTTP請求中能夠獲取到的環境變量了,你可以直接在請求的HTTP的腳本中通過{{xx}}佔位符的方式獲取到這裡配置的參數

    <code>{
      "uat": {
        "baseUrl": "http://gateway.xxx.cn/",
        "username": "",
        "password": ""
      },
      "dev": {
        "baseUrl": "http://localhsot:8888/",
        "username": "",
        "password": ""
      }
    }/<code>

    那麼在選擇執行請求的時候,IDEA就會讓你選執行那個環境的配置,如:

    是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器!

    結果斷言

    IDEA REST Client可以針對接口的響應值進行腳本化的斷言處理,立馬從一個接口調試工具上升到測試工具了,比如:

    <code>### Successful test: check response status is 200
    GET https://httpbin.org/status/200
    
    > {%
    client.test("Request executed successfully", function() {
      client.assert(response.status === 200, "Response status is not 200");
    });
    %}/<code>

    結果值暫存

    試想下這樣的場景,當一個系統需要通過認證才能訪問的時候,如果用postman的時候,是不是先訪問登錄接口,然後獲得token後,手動粘貼複製到新的調試接口的header參數裡面去,這太麻煩了,IDEA REST Client還有一個真香的功能,可以完美解決這個問題,請看下面的腳本:

    <code>### 演示POST請求
    POST https://httpbin.org/post
    Content-Type: application/json
    
    {
      "user": "admin",
      "password": "123456"
    }
    
    > {% client.global.set("auth_token", response.body.json.token); %}
    ### 演示GET請求
    
    GET https://httpbin.org/headers
    Authorization: Bearer {{auth_token}}/<code>

    在第一個認證的請求結束後,可以在response裡拿到返回的token信息,然後我們通過腳本設置到了全局變量裡,那麼在接下來的接口請求中,就可以直接使用雙大括號佔位符的方式獲取到這個token了


    結語

    postman有口皆碑,確實是一個非常不錯的必備工具,之前給比人推薦這種工具時總是安利他postman。但是,IDEA REST Client也真的很不錯,值得嘗試一下,後面安利這種工具就切換到IDEA REST Client了,postman反正被我丟掉了。和第三方做接口對接時,項目裡必備一個rest-http.http接口請求文件,滿足自己的同時也成方便了他人。

    對了,在這裡說一下,我目前是在職Java開發,如果你現在正在學習Java,瞭解Java,渴望成為一名合格的Java開發工程師,在入門學習Java的過程當中缺乏基礎入門的視頻教程,可以關注並私信我:01。獲取。我這裡有最新的Java基礎全套視頻教程。


    分享到:


    相關文章: