用 Postman Integrations,自動備份 Postman Collection

用 Postman Integrations,自動備份 Postman Collection

本篇要解決的問題

上個月在〈用 Google Apps Script,定期備份 Postman〉有提到,在亂點之下看到 Postman 原有的備份功能,後來因為找不到才寫了那篇筆記文,結果很意外的,這幾點為了找別的設定,竟然找到了耶。

而且用起來很簡單,只要 Collection 裡有變動就會自動執行備份,這麼好用的功能怎麼可以不記錄一下呢?


建立 GitHub 專案及 Access Token

本篇示範的是自動將 Postman Collection 備份到 GitHub 上,需要先建立備份用的專案,及新增一組 Access Token。

建立專案時,可選為 Private,另外 Add a README file 也可打勾,我們要先有一個檔案,讓主要分支可以建立起來:

打勾 Private、Add a README file

專案建好後,接著要建立一個 Access Token。

點擊此連結進到產生 Token 的頁面:Personal access tokens (classic)

點擊右上角的 Generate new token > Generate new token(classic)

點擊 Generate new token > Generate new token(classic)

接著看下圖:

建立 GitHub Access Token

Note 部份取一個認得出功能的說明。

Expiration 選擇 No expiration

Select scopes 的部份,repo 打勾。

頁面滑到最下面,點擊 Generate Token,就會建立一組 Token,記得把 Token 複製下來,下一步馬上就會用到。


Postman Integrations,GitHub backup

打開 Postman,點擊我們想要備份的 Collection,最右側會出現一排選單,點擊最下面「i」的那個 Icon:

點擊 Collection、Icon

點擊 i 的 Icon 後,會出現 Collection 的資訊,最下面就會看到寫著 Back up 的說明文字:

Back up your collection

點擊 View all options,就會看見目前有以下這 9 種備份方式:

Postman 9 種備份方式

本篇用的是備份到 GitHub 上,因此點擊 GitHub,會看到以下:

點擊 Backup a collection Add Integration

因為我們單純是要備份 Collection,所以點擊 Backup a collectionAdd Integration

點擊後,第一步 Postman 會要求填上 Personal Access Token,我們把從第一步取得的 GitHub Access Token 複製貼上,然後點擊 Authenticate and Proceed

接著就是一個表格,要填的是備份的一些設定。

因為我們在第一步就先建立好了 GitHub 專案,及專案中的分支,因此大部份欄位都是用選的,除了 Nickname、Enter Directory (optional)、Enter filename 這三個必須要手填。

要注意的是,填寫的值要都用英文,原本 August 為了好認所以填寫了中文,結果會一直備份失敗,直到都換成了英文才成功。

以下是 August 備份調用 ChatGPT API 的填寫範例:

Add integration 填寫範例

都選好及寫好後,就可以點擊 Add integration

新增成功,就會看到 Integration 頁面多出了這次的備份設定:

自動備份設定成功

點進去就可以看見是成功或失敗:

顯示備份結果

右上角的三個按鈕也都可以點擊。

再進到 GitHub 我們設定要拿來備份的專案上,就會看見 Collection 已經備份完成:

GitHub 上備份完成

目前使用的狀況,除了有時候會秀逗沒有進行備份,大部份只要 Collection 裡有變動,就會觸發自動備份。

是不是很簡單呢?