iT邦幫忙

2021 iThome 鐵人賽

DAY 3
0
Software Development

Laravel 新手初見 API系列 第 3

Day03-CRUD API 實作(三)Route、Postman 測試 API

大家好~
昨天完成會員系統的 Controller,
今天要來完成會員系統的 Route ,
並且用 Postman 測試一下我們會員系統的功能是否正常!

Route

將我們寫好的功能加入 routes/api.php 內。

use  App\Http\Controllers\AuthController;

Route::post('/register', [AuthController::class, 'register']);
Route::post('/login', [AuthController::class, 'login']);

// 將需要帶 Token 才能使用的 API 放在下面的 Route::group
Route::group(['middleware' => ['auth:sanctum']], function () {
    Route::get('/logout', [AuthController::class, 'logout']);
});

Route 的寫法在 Laravel 8 做了次更新,
舊版的寫法(如下圖)已不再支援。

php artisan route:list

使用該指令可以列出所有的 Route,
在該指令後方加上| grep 關鍵字
即可做到搜尋,如下圖:

Route 完成後我們就來用 Postman 做測試吧!

使用 Postman 測試 API

Postman 的安裝與詳細介紹網路上已有許多教學,
文末的參考資料會推薦幾篇關於 Postman 的教學文章。

首先在我們專案的資料夾下該指令來啟動本地 Server:

php artisan serve

Environments 簡介


在 Environments 可以設定環境參數,
像上圖我有設定了 url 的環境參數,
之後我有需要在 Postman 用到 http://127.0.0.1:8000 時,
只需要用 {{url}} 就可以調用我所設定的環境參數。

Register 測試

  1. 選擇我們 API 所使用的 Request methods
  2. API 的 Endpoint
  3. Request 的 設定
    • Headers 與 Body 填入我們要傳給 API 的 Key 與 Value
  4. 發送 Request
  5. 取得我們 API 的 Response

Login 測試

Logout 測試

測試完畢~
三個功能皆是正常的!

其中登出是必須帶 Token 才能使用的功能,
而在 Postman 內要帶 Token 的話,
可以在 Authorization 內選擇 Type,
我們 Token 的 Type 為 Bearer Token 。

今天差不多就先這樣啦,
那麼明天就要開始做留言的 Model 囉。

大家明天見啦~
若文章有任何問題,
還請大家不吝賜教!

參考資料


上一篇
Day02-CRUD API 實作(二)Laravel Sanctum 會員註冊、登入、登出
下一篇
Day04-CRUD API 實作(四)Model、Migration
系列文
Laravel 新手初見 API30

尚未有邦友留言

立即登入留言