iT邦幫忙

2024 iThome 鐵人賽

DAY 16
0

嗨大家好!我是2魚,今天要和大家分享如何使用 Postman 來測試 API。還記得我們辛辛苦苦寫好的 API 嗎?接下來就讓我們來驗證成果吧!

開發 API 後的小抱怨時間

寫完 API 後,你是不是也和我一樣有種「蝦?我到底在寫啥」的感覺?一堆程式碼看得眼花撩亂,卻不知道到底有沒有用?別擔心,這很正常!這就是為什麼我們需要 Postman 這個超級好用的工具來幫忙。

Postman:工程師的神隊友

Postman 可以模擬各種 HTTP 請求,幫我們測試 API 的功能。簡單說,它就是一個可以幫我們「假裝是使用者」的工具,讓我們不用真的寫前端就能測試後端。太方便了,對吧?

step1. 下載和註冊 Postman

首先,讓我們從 Postman官網 下載並安裝Postman。

💡 小提示:Postman支持多種操作系統,包括Windows、macOS和Linux。選擇適合你系統的版本進行下載。

step2. 打開應用程式並登入

安裝完成後,打開Postman並創建一個帳號或使用現有帳號登入。登入後,你將看到Postman的主界面。

step3. 建立工作區

工作區(Workspace)是Postman中組織和管理API請求的重要概念。它就像是一個虛擬的辦公室,你可以在這裡整理所有與特定項目相關的API請求。

老實說,我一開始也不知道工作區這麼好用,害我把首頁用的超級亂的 😅

  • 在左上角找到「Workspaces」,點擊「Create Workspace」
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686kR84yDoczw.png
  • 選擇「Blank Workspace」來創建一個空白的工作區
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686dIi0nvkwhN.png
  • 你的工作區命名。選擇一個有意義的名稱,例如「test-app api」
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686W4prt8XuzY.png

💡 小技巧:取個好記的名字很重要喔!我通常會用專案名稱或 API 的主要功能來命名。

step4. 在工作區中創建集合

集合(Collection)是Postman中用來組織相關API請求的容器。想像它就像是一個文件夾,裡面存放著同一個API或同一個項目的所有相關請求。

  • 點擊「+」按鈕,然後選擇「Blank collection」
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686vl685iRXd7.png

  • 為集合命名。在這個例子中,我們將其命名為「local - feedback」,因為我們要在本地測試feedback API
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686h4GGTKVU8X.png

    💡 小提醒:集合名稱最好能反映裡面 API 的功能喔!像是測試會員註冊的 API,你可以叫它「User Registration API」之類的。

step5. 創建並測試第一個API請求

現在,讓我們創建一個請求來測試「新增feedback」的功能。

  • 在剛剛創建的集合中,點擊「Add request」
    https://ithelp.ithome.com.tw/upload/images/20240925/201596865ZzTTyomZr.png

  • 幫這個請求取名,就叫「新增 feedback」吧
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686dbOkmvQqCS.png

  • 設置請求方法為 POST(記得嗎?這是我們在 routes/feedback.js 裡定義的)
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686nBKpwlttuK.png

  • 輸入請求URL:http://127.0.0.1:3000/feedbacks/

    • http://127.0.0.1:3000 是本地服務器地址(當你運行 npm start 時使用的地址)
    • /feedbacks 是在 app.js 中定義的路由前綴
      https://ithelp.ithome.com.tw/upload/images/20240925/20159686VWfyoyZDWM.png
    • 最後的 / 對應 routes/feedback.js 中定義的根路由
      https://ithelp.ithome.com.tw/upload/images/20240925/2015968668Fd2O76RZ.png

💡 小知識:127.0.0.1 就是俗稱的 localhost,代表你的電腦自己。在開發時我們常用這個地址來測試。

  • 在「Body」標籤頁中,選擇「raw」並將格式設為「JSON」,然後輸入以下測試資料:

    {
        "contactPerson": "測試人員",
        "email": "test@gmail.com",
        "feedback": "測試回饋"
    }
    

    💡 小補充:JSON(JavaScript Object Notation)是一種輕量級的資料交換格式,在 API 溝通中超常用。它不只容易讓人讀懂,電腦也很容易處理喔!

  • 按下「Send」按鈕發送請求。如果一切順利,你應該會看到類似這樣的回應:
    https://ithelp.ithome.com.tw/upload/images/20240925/201596861fBZOPgAyO.png

    這個回應對應了我們在 routes/feedback.js 中第 24 行的程式碼:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686toovyysloI.png

  • 要確認資料是不是真的存到資料庫了,我們可以打開 MongoDB Compass 看看:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686OjXM1ViyEP.png

step6. 測試錯誤情況 (試打失敗請求)

測試 API 時,我們不只要確保正確的輸入能正常運作,還要確認 API 能適當處理錯誤的輸入。這就像是在檢查一個自動販賣機,不只要確定它能正確給出商品,還要確保當投幣不足或選擇的商品賣完時,它能給出適當的提示。

  • 先回顧一下我們的錯誤處理邏輯:
    https://ithelp.ithome.com.tw/upload/images/20240925/201596861nVzJeedPz.png

  • 現在,我們來修改 Postman 中的請求內容,故意少寫一個必填欄位:

    {
        "contactPerson": "測試人員",
        "email": "test@gmail.com"
    }
    
  • 發送請求後,你應該會看到一個錯誤回應:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686X1YcYw9WaV.png
    這個回應對應了程式碼中第 11 行的錯誤處理邏輯。

💡 小撇步:要做好 API 測試,最好能想到各種可能的輸入情況,包括正確的、錯誤的,甚至是一些奇奇怪怪的邊界情況。這樣才能確保你的 API 在各種情況下都能正確運作喔!


其他 API 操作的 Postman 測試

獲取所有feedback

  • 方法:GET(就像是在自動販賣機上按「顯示所有商品」的按鈕)
  • URL:http://127.0.0.1:3000/feedbacks/
  • 結果示例:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686f7Fls8tIq7.png

獲取指定 ID 的 feedback

  • 方法:GET(這次是按「顯示特定商品詳情」的按鈕)

  • URL:http://127.0.0.1:3000/feedbacks/:id(記得把 :id 換成實際的 ID 喔)

  • 如何獲取 ID:可以從 MongoDB Compass 中複製物件的 ID
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686QyfRkCHxrD.png

  • 結果示例:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686iWJZabxfOh.png

更新指定 ID 的 feedback

  • 方法:PATCH(就像是在自動販賣機上更改你的訂單)

  • URL:http://127.0.0.1:3000/feedbacks/:id (別忘了把 :id 換成你要更新的 feedback 的實際 ID 喔)

  • Body示例:

    {
        "contactPerson": "測試人員",
        "email": "test@gmail.com",
        "feedback": "測試更新"
    }
    
  • 結果示例:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686HpLXp2h1nl.png

刪除指定 ID 的 feedback

  • 方法:DELETE(想像成按下自動販賣機上的「取消訂單」按鈕)
  • URL:http://127.0.0.1:3000/feedbacks/:id (記得替換 :id 喔)
  • 結果示例:
    https://ithelp.ithome.com.tw/upload/images/20240925/20159686OPNfEtYy01.png

    小提醒:刪除操作要小心使用,因為它通常是不可逆的。在實際應用中,我們可能會考慮使用「軟刪除」(將資料標記為已刪除而不是真的刪掉)來避免意外情況。

總結

哇!我們終於完成了所有 CRUD(創建、讀取、更新、刪除)操作的測試。是不是感覺對 API 更有掌控感了呢?使用 Postman 真的讓 API 測試變得超級方便,就像是有了一個強大的翻譯器,幫我們和後端溝通。

記住,好的 API 測試不只是確保功能正常,還要考慮各種可能的情況:

  1. 正確的輸入:確保 API 在正常情況下工作正常。
  2. 錯誤的輸入:測試 API 如何處理異常情況,例如缺少必要欄位或格式錯誤。
  3. 邊界情況:測試一些極端情況,例如很長的字串或特殊字符。
  4. 權限測試:如果你的 API 有權限控制,要確保未授權的請求被正確拒絕。
    透過這些測試,我們可以大大提高 API 的穩定性和可靠性。這就像是在發布前給自動販賣機做全面檢查,確保它能夠應對各種情況,不會在用戶使用時出現意外。

下一步

學會使用 Postman 只是開始哦!接下來,你可以自行探索更多 Postman 的進階功能,例如:

  1. 環境變數:用於管理不同環境(如開發、測試、生產)的設定。
  2. 自動化測試:編寫測試腳本,自動驗證 API 響應。
  3. 監控:設置定期運行的測試,確保 API 持續可用。
  4. 文檔生成:基於你的 API 請求自動生成文檔。
    記住,API 開發和測試是一個持續學習的過程。每次你遇到新的挑戰,解決新的問題,都是在提升自己的技能。保持好奇心,不斷嘗試新東西,你會發現 API 的世界其實超有趣的!

最後,希望這篇教學對你有幫助。如果你有任何問題或想分享你的 API 測試經驗,歡迎留言討論哦!我們一起在程式設計的海洋中航行,一起成長進步!加油!🚀✨
(對了,如果你覺得今天的內容對你有幫助,別忘了給個讚支持一下喔!這會是我繼續努力的動力呢~)


上一篇
[ DAY15 ] 打造自己的 API:CRUD 基本功
下一篇
[ DAY17 ] 後端開發的關鍵:可重用函式設計與全面錯誤管理
系列文
房東不給養鸚鵡 - 那就用 Nuxt + Express + MongoDB 30 天寫一個全端鸚鵡專案18
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言