使用 Postman 測試 Django 後端的註冊、登入與登出功能
更新日期: 2025 年 1 月 29 日
本文為 Django 登入註冊功能(後端)系列文,第 10 篇
- 新手指南|使用 Django 實現後端會員登入、註冊功能
- Django Rest Framework (DRF) 新手指南:為什麼選擇 DRF 建構 API?
- Django Rest Framework (DRF) 新手指南:用 ViewSets 快速構建 CRUD API
- 初學者指南:理解 Token 認證及其運作方式
- Django REST Framework (DRF) 認證方式、預設權限規則|新手指南
- Django Rest Framework 入門指南:如何正確處理 HTTP 狀態碼
- 初學者指南:深入了解 Django 的 create_user 方法
- 新手指南:深入了解 Django 的 authenticate 方法
- Django REST Framework|@permission_classes指導手冊
- 使用 Postman 測試 Django 後端的註冊、登入與登出功能 👈所在位置
如果你正在學習如何使用 Postman 測試 Django 後端的 API,那麼恭喜你!
這篇文章將詳細介紹如何進行註冊、登入和登出功能的測試。
我們將一步步引導你完成設定,並提供範例資料和響應格式,讓你快速上手。
Postman 是什麼?
Postman 是一款功能強大的 API 測試工具,用來模擬 HTTP 請求並查看後端響應的細節。
在測試 Django 開發的後端時,Postman 能有效協助你檢查 API 是否運作正常。
本指南專為新手設計,涵蓋以下三個常見的功能測試:
- 註冊(Register)
- 登入(Login)
- 登出(Logout)
準備好後,我們就開始吧!
測試註冊功能
註冊功能允許用戶創建帳號,以下是操作步驟:
設定請求類型與 URL
- 請求類型:
POST
- URL:
http://127.0.0.1:8000/api/users/register/
(如果你的後端註冊端點不同,請替換成對應的 URL。)
切換到 Body 標籤
- 在 Postman 中選擇
Body
。 - 選擇
raw
格式。 - 在右側的下拉選單中選擇 JSON。
輸入註冊資料
填入後端 API 要求的 JSON 格式資料。例如:
{
"username": "testuser",
"email": "[email protected]",
"password": "testpassword",
"password2": "testpassword"
}
點擊 Send
- 如果註冊成功,後端應返回類似以下的響應:
{ "message": "註冊成功!" }
- 如果註冊失敗(例如密碼不一致或用戶已存在),則可能返回:
{ "error": "密碼不一致!" }
測試登入功能
登入功能讓用戶獲取授權 Token,以下是操作步驟:
設定請求類型與 URL
- 請求類型:
POST
- URL:
http://127.0.0.1:8000/api/users/login/
切換到 Body 標籤
- 選擇
Body
。 - 選擇
raw
格式,並切換到 JSON。
輸入登入資料
填入你的登入 API 所需參數,例如:
{
"username": "testuser",
"password": "testpassword"
}
點擊 Send
- 如果登入成功,後端會返回 Token,類似以下格式:
{ "token": "abcd1234efgh5678ijkl9012mnop3456", "message": "登入成功!" }
- 如果失敗(例如帳號或密碼錯誤),則返回:
{ "error": "登入失敗,請檢查使用者名稱或密碼!" }
注意:記下返回的 token
,它會在後續登出和其他 API 測試中使用。
測試登出功能
登出功能用於銷毀授權 Token,以下是操作步驟:
設定請求類型與 URL
- 請求類型:
POST
- URL:
http://127.0.0.1:8000/api/users/logout/
在 Headers 中添加 Token
- 點擊 Postman 的 Headers 標籤。
- 添加以下內容:
Key: Authorization
Value: Token <你的登入 Token>
- 例如:
Authorization: Token abcd1234efgh5678ijkl9012mnop3456
點擊 Send
- 如果登出成功,後端會返回:
{ "message": "已成功登出!" }
- 如果未提供 Token 或 Token 無效,可能返回:
{ "detail": "認證憑證無效。" }
常見注意事項
在測試過程中,請留意以下幾點:
- URL 是否正確:確保 Postman 中的 URL 與後端 API 的路徑一致。
- 資料格式:大多數 API 要求 JSON 格式,在 Postman 中選擇
raw
並切換到 JSON。 - Token 的使用:Token 是登出或授權相關操作的關鍵,請務必在請求 Header 中正確添加。
- 後端狀態:確保 Django 開發伺服器已啟動,並在正確的端口運行(默認為
http://127.0.0.1:8000
)。
範例測試流程
以下是完整的範例測試流程:
註冊
- URL:
http://127.0.0.1:8000/api/users/register/
- 請求類型:
POST
- Body:
{
"username": "testuser",
"email": "[email protected]",
"password": "123456",
"password2": "123456"
}
登入
- URL:
http://127.0.0.1:8000/api/users/login/
- 請求類型:
POST
- Body:
{
"username": "testuser",
"password": "123456"
}
- 記錄返回的 Token,例如:
abcd1234efgh5678ijkl9012mnop3456
登出
- URL:
http://127.0.0.1:8000/api/users/logout/
- 請求類型:
POST
- Headers:
Authorization: Token abcd1234efgh5678ijkl9012mnop3456
結語
使用 Postman 測試 Django 後端 API 是一個高效的方式來確保功能正常運作。
通過本文提供的步驟與範例,你應該可以順利完成註冊、登入和登出的測試。
如果在操作過程中遇到問題,可以檢查路徑、資料格式或後端服務是否正確配置。
祝你測試順利! 🎉