後端框架與API 開發(6-2) - API 測試工具：Postman

※ 什麼是Postman？

在開發、測試程式時，很常需要在串接使用前，先確認API 是否正常。

而 Postman 是一個非常方便好用的API測試工具。

※ 以下是 Postman 的主要功能：

1. 請求方法與請求網址：你可以選擇 API 的方法（例如 GET、POST、PUT、DELETE 等）和請求路徑 URL。
2. 參數設定：你可以在請求中附加特定資訊，提供請求的細部設定，分別是 URL 網址、Header、Body。
3. 回應查看：你可以檢視 API 回應的資料、回應的資訊。
4. 環境變量與預先腳本：Postman 提供了環境變量和預先腳本的功能，這些可以使我們的 API 開發和測試工作變得更加高效。
5. 測試腳本：你可以撰寫測試腳本來驗證 API 的回應是否符合預期。
6. 文檔生成：Postman 可以自動生成 API 的文檔，方便團隊協作。

※ 安裝與註冊 Postman

• 請到 Postman 的官方網站下載應用程式，並根據你的電腦選擇對應的版本：https://www.getpostman.com/downloads/

• 首次使用會需要註冊，安裝、註冊完之後，打開程式首頁 (Home) 會是這樣：

※ 為專案建立專用 Workspace

• Create Workspace（創建工作區）：可以組織和管理你的 API 項目。

以下是創建一個新工作區的步驟：

1. 在左上角選擇 “Workspaces”（工作區），然後選擇 “Create Workspace”（創建工作區）以添加一個新的工作區。
2. 為你的工作區輸入一個名稱：

3. 為 Workspace 命名並選擇存取權限，先選 Personal 就可以了：

4. 按下 Create Workspace 後就會看到此畫面：

※ 建立 Collection

左手邊的側邊欄裡面有個 Collections 的功能，這個功能能夠讓你把功能相近、彼此相關的請求都整理在一個群組、方便管理。

• 點擊 Create collection：

• 幫這個群組取個適當的名字：

※ 新增請求

• 點擊 Add a request 後，右手邊會出現一個跟瀏覽器有點像的介面，請你：

※ 使用 Postman 發出 HTTP Request

• 讓我們試著對文章列表 http://localhost:3000/api/articles 來發送請求，請輸入 URL 之後選擇 GET 動作，按下 Send 按鈕，看看回傳結果：

• 再試驗一下取得單篇文章http://localhost:3000/api/articles/1 應該也是可以順利取得：

• 再試驗一下新增單篇文章http://localhost:3000/api/articles 應該也是可以順利取得：

※ 建立環境變數

打同一支 API 的時候，前面有一段網址是固定不變的，例如我們當前都是 http://localhost:3000，這時我們可以把這一段 URL 設定至環境變數。

• 點擊側邊欄的 Environments，按下 Create new Environments，根據下圖操作：

• 回到 Collections，把剛剛網址列中的 http://localhost:3000 圈起來，點擊 Set as variable：

• 按照下圖輸入：

• 設定好了以後這段網址就會改成以 {{base_url}} 變數形式呈現，可以再重新發送一次請求，應該也會成功拿到資料：

！！之後再發送其他請求到本地端時就可以使用此變數，要注意一個小細節是我們的變數最後面沒有帶 /，如果你有把斜線也設定進去，那網址列就不要再重複寫，別搞烏龍了喲！