Postman分享接口：方便簡潔的API管理工具

Postman是一款RESTful API開發人員常用的chrome瀏覽器擴展插件，可以方便地進行HTTP請求的測試，支持各種API不同協議，比如GET、POST、PUT、DELETE、PATCH等，並且支持數據參數化，也可以輕鬆導出接口文檔或者分享給團隊成員。本文將從多個方面對Postman分享接口進行詳細闡述。

一、首先，如何獲取到Postman？

你可以在谷歌應用市場裏面下載到：https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop

然後你會看到如下圖所示的界面：

// 插件的關鍵方法，通過調用此方法自動安裝插件。
function installPlugin() {
    if (window.chrome && chrome.webstore) {
        // 如果插件已安裝，提示此時不需要重複安裝。
        if (chrome.app.isInstalled) {
            alert('插件已存在');
            return;
        }

        chrome.webstore.install(
            "https://chrome.google.com/webstore/detail/fhbjgbiflinjbdggehcddcbncdddomop",
            function () {
                alert('插件安裝成功！');
                console.log('插件安裝成功！');
            },
            function () {
                alert('插件安裝失敗！');
                console.log('插件安裝失敗！');
            }
        );
    }
}

二、如何使用Postman分享接口？

1、首先需要在Postman中創建接口。

點擊左上角的New按鈕新建請求，如下圖所示：

然後在彈出框中輸入請求名稱和URL地址，如下圖所示：

2、調試驗證接口

在Postman中驗證API，可以根據需要對請求進行參數配置，調試請求是否返回正確的數據。

比如，下面我們模擬登錄請求，配置請求參數：

然後點擊「Send」按鈕，進行請求測試。請求發送完成後，我們可以在Response面板中查看響應結果，如下圖所示：

如果設置的參數有誤，請求會返回錯誤信息：

三、如何導出接口文檔?

在使用Postman管理API新建接口後，可以隨時導出接口文檔。導出的格式包括JSON、YAML和CSV等多種格式，方便後續與團隊成員分享。

具體操作步驟如下：

1、在打開的接口列表中，勾選需要導出的接口。

2、點擊右鍵，彈出上下文菜單，選擇「Export」。

3、在彈出的對話框中，選擇需要導出的格式以及保存的路徑，如下圖所示：

四、如何分享接口?

當你需要和其他團隊成員協作開發API時，可以使用Postman分享接口的功能。具體操作步驟如下：

1、在打開的接口列表中，勾選需要分享的接口。

2、點擊右鍵，彈出上下文菜單，選擇「Share Collection」。

3、在彈出的分享對話框中，輸入接受方的電子郵件地址，然後點擊「Share」按鈕提交請求。

4、接受方會通過郵件接收到分享鏈接，可以直接打開Postman並查看到分享的接口。

五、如何在Postman中使用數據驅動及環境變量？

據驅動功能可以極大的減小寫測試代碼的數量，減小維護測試代碼的難度。而環境變量可以更好的管理和維護不同環境下的接口。

具體的步驟如下：

1、數據驅動

新建或編輯Collection，Postman支持在請求執行時讀取CSV、JSON、XML等格式的數據文件，並使用讀入的參數進行請求參數化，批量執行要自動化的API接口請求。以CSV格式的數據文件為例，創建如下圖所示格式的數據文件：

然後在需要使用該數據的接口中導入該數據文件（可能需要先保存），在請求區塊Parameters >> Body中使用{{variable_name}}語法引用讀入的數據。

2、環境變量

環境變量類似於全局變量，可以儲存在Collection或者請求中，並且在執行過程中可以被替換。

在使用Postman管理多個API接口時，API可能需要在不同的環境下運行，比如開發、測試和生產環境。我們可以通過設置多個環境變量，從而在不同的環境中覆蓋不同的value值。

例如，可以設置一個名為「url」的環境變量，以儲存API的URL值。然後在Collection中使用{{url}}的形式引用該環境變量，這樣就可以方便地在不同的環境中切換API地址了。

六、如何使用Postman集成測試，並將結果和其他應用進行集成？

Postman集成了一下測試框架：

• Chai
• Mocha
• Newman

可以通過集成測試框架進行API自動化測試。

具體操作步驟如下：

1、用Postman編寫測試腳本。

在Postman中打開要測試的API，選擇「Tests」選項卡，即可進入編寫測試腳本的界面。測試腳本可以使用JavaScript語言進行編寫，在測試腳本中可以通過請求的響應數據來驗證API接口的正確性和是否返回正確的結果。下面是一個測試示例：

var jsonData = JSON.parse(responseBody);

tests["返回狀態碼是200"] = responseCode.code === 200;
tests["返回的消息體內容正確"] = jsonData.value === "hello world";

上面的示例測試腳本驗證了請求是否返回了狀態碼為200的響應以及響應消息體是否正確。

2、導出測試結果。

在Postman中，通過選擇「Runner」選項卡，進入Postman Runner界面，我們可以選擇需要測試的Collection和Environment，並進行批量測試。測試完成後，點擊右上角的「Export」按鈕，即可將測試結果導出為HTML或JSON格式。

此外，Postman還提供了API，可以通過API獲取測試結果以及集成到其他應用程序中，如CI/CD工具等。

七、總結

Postman是一個功能強大而方便的API管理工具，它支持多種方法、數據驅動、環境變量、測試並集成測試等眾多功能。它為API的開發、測試和協作提供了簡單且強大的工具。