PostmanAPI

發表於 更新於 分類於

PostmanAPI 同步機制

Postman 是很好用的 HttpRequest 工具，個人使用沒有限制，但它的多人協作方案（Team，Business，Enterprise）是用 user/month 計費…太貴了…$_$

貧窮限制了我們的生產力，只好寫更多 Code 來彌補了！

此同步機制，使用 Postman API + Nodejs + Git 達成近似雲端協作的效果

Prerequisites

  1. git clone

  2. 安裝 Postman 應用程式

  3. 登入 Postman 帳號

Getting Started

1. 取得API Key

  • 打開Postman應用程式 –> UserProfile Icon –> Account Settings

  • Postman API keys –> Generate API Key

  • 輸入任意識別名稱

  • 產生成功，把 Key 複製起來備用

2. 安裝與設定

以下指令與步驟都是在PostmanAPI資料夾下進行

  • 安裝相依套件

    1
    npm install

  • 將 .env.example 複製並更名為 .env

    1
    cp .env.example .env

  • 把Step1中取得的API Key貼到 .env 中

    1
    2
    POSTMAN_APIKey=貼上你的APIKey
    TEAM_WORKSPACE_NAME=Team LinkChain

How to Use

  • 由檔案匯入至 Postman

    1
    npm run import

  • 由 Postman 匯出至檔案

    1
    npm run export

  • Git 同步

    1
    2
    3
    4
    5
    git pull # 提取
    .
    .
    .
    git push # 推送

  • 同步的Workspace ： Team LinkChain

Use Cases

  1. 第一次使用

    1
    npm run import # 由檔案匯入至Postman

  2. 之前已經匯入過，同事通知有新的API內容

    1
    git pull # 提取
    1
    npm run import # 由檔案匯入至Postman

  3. 你修改了一些API內容，想傳送給其他同事

    1
    npm run export # 匯出Postman至檔案
    1
    2
    git add .
    git commit -m "提交內容描述"
    1
    2
    3
    4
    5
    git pull # 提取
    #
    # 若有衝突則先行解決
    #
    git push # 推送

Branch Strategy

  • master ： 資料同步

  • develop ： 核心程式開發

  • 其他功能性分支使用 git flow

Price and Limit

透過 Postman API 存取資源，每分鐘不可超過 60 次Request，且每個月不可超過 1000 次Request，因此要省點用XD。

x ： Collection數量

y ： Environment數量

每次執行匯入或匯出指令， API Request 使用量為：

1
2 + x + y

目標是盡量降低 x 與 y ，建議每個專案的API就放在一個Collection裡面，Environment就固定使用四個。

References

https://www.postman.com/postman/workspace/postman-public-workspace