Laravel開發:如何使用Laravel Passport實現API身份驗證?

laravel是一個開源的php web應用程序框架,旨在幫助開發者輕松構建高效的web應用程序。laravel passport是laravel框架的一部分,它是一個實現oauth2協議的身份驗證服務器,為api開發提供了強大的支持。在本文中,我們將介紹如何使用laravel passport實現api身份驗證。

  1. 安裝Laravel Passport

使用Laravel Passport之前,我們需要先安裝它。可以通過運行以下命令來安裝Laravel Passport:

composer require laravel/passport

安裝完成后,還需要運行php artisan migrate命令來創建所需的數據表。

  1. 配置認證中間件

要使用Laravel Passport進行API身份驗證,我們需要將其與Laravel的認證中間件結合使用。可以在app/http/Kernel.php文件中為API組添加相應的認證中間件:

protected $middlewareGroups = [     'api' => [         'throttle:60,1',         IlluminateRoutingMiddlewareSubstituteBindings::class,         LaravelPassportHttpMiddlewareCreateFreshApiToken::class,     ], ];

其中,CreateFreshApiToken中間件將在每個請求中檢查API令牌,并在需要時自動刷新該令牌。

  1. 創建API認證路由

接下來,我們需要為API創建相應的認證路由。可以在routes/api.php文件中添加以下路由:

Route::post('login', 'APIAuthController@login'); Route::post('register', 'APIAuthController@register');  Route::group(['middleware' => ['auth:api']], function() {     Route::get('details', 'APIAuthController@details');     // 添加更多需要登錄才能訪問的API路由 });

在上面的代碼中,auth:api中間件將確保只有已經通過身份驗證的用戶才能訪問這些路由。AuthController是我們稍后將創建的控制器,其中包含處理身份驗證和API路由的邏輯。

  1. 創建API認證控制器

現在,我們需要創建處理API身份驗證和路由的控制器。可以使用以下命令創建AuthController:

php artisan make:controller API/AuthController

AuthController中應該包含以下方法:

use IlluminateHttpRequest; use IlluminateSupportFacadesAuth; use IlluminateSupportFacadesValidator; use AppUser;  class AuthController extends Controller {     /**      * 用戶注冊      *      * @param  IlluminateHttpRequest  $request      * @return IlluminateHttpResponse      */     public function register(Request $request)     {         $validator = Validator::make($request->all(), [             'name' => 'required|string|max:255',             'email' => 'required|string|email|unique:users',             'password' => 'required|string|min:6',         ]);          if ($validator->fails()){             return response(['errors'=>$validator->errors()->all()], 400);         }          $request['password'] = bcrypt($request['password']);         $user = User::create($request->toArray());         $token = $user->createToken('MyApp')->accessToken;         return response(['token' => $token], 200);     }      /**      * 用戶登錄      *      * @param  IlluminateHttpRequest  $request      * @return IlluminateHttpResponse      */     public function login(Request $request)     {         $validator = Validator::make($request->all(), [             'email' => 'required|string|email',             'password' => 'required|string',         ]);          if ($validator->fails()) {             return response(['errors'=>$validator->errors()->all()], 400);         }          if (!Auth::attempt(['email' => $request['email'], 'password' => $request['password']])) {             return response(['message' => 'Invalid login credentials'], 400);         }          $user = $request->user();         $token = $user->createToken('MyApp')->accessToken;         return response(['token' => $token], 200);     }      /**      * 獲取用戶詳細信息      *      * @param  IlluminateHttpRequest  $request      * @return IlluminateHttpResponse      */     public function details(Request $request)     {         return response()->json(['user' => $request->user()], 200);     } }

register()方法用于用戶注冊,login()方法用于用戶登錄,details()方法用于獲取已登錄用戶的詳細信息。需要注意的是,register()和login()方法將為已經通過驗證的用戶創建新的API令牌,并將其返回給客戶端。

  1. 測試API身份驗證

現在,我們可以通過發送用戶名和密碼來測試API身份驗證。可以使用postmancURL等工具執行以下命令:

curl -X POST    http://your-app-url/api/login    -H 'content-type: application/json'    -d '{     "email": "user@example.com",     "password": "password" }'

如果用戶名和密碼是正確的,將收到包含API令牌的響應:

{     "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImU4YmI2Njk0MGEyNmIzY2Q2ZmY4M2Q3MjQ5ZjgzODE1MTI2ZmRkMDIyM2YyMzVmOGZmNjhlOWM5NGU2Mzk4ZTU3ZWZiMDJhNmQyZmRlZjA2In0.eyJhdWQiOiIxIiwianRpIjoiZThiYjY2OTAwZTI2YjNjZDZmZjgzZDcyNDlmODM4MTUxMjZmZGQwMjIzZjIzNWY4ZmY2OGU5Yzk0ZTYzOThlNTdlZmIwMmE2ZDJmZGVmMDYiLCJpYXQiOjE2Mjg5NDM3NzQsIm5iZiI6MTYyODk0Mzc3NCwiZXhwIjoxNjMxMDQ5Nzc0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.toR762TgsNDarQZs6azl-jg-tP2996vzUc-LOQB90Twcb0Y3BC5vrd3jDW70QQw961MwV_sFrU1dhyKLMN76lG6B03zv6GjU6tLHyrqQi88t0clSrVupAcaQHOAB0gGLBRAOc5Ql1z9CHXx8f_FkA3RVC4htHNTk_r0mM-szWcf1sRONQYaARPDFl7ZJwj1_wYB7M6dcpiEDDhpyzmRFPv7pYyX8805BL4yg6z-Kmxc-DW4GSS4NTBxnctwGPf9w8fYc2zJGHXmT6OtqVjuqKDdFQgxIQhEkeSldBZmzTIPIR_tTa8Ub3Cxlx69zAfJTHosXwPYQOO03LBJwNVdjeLIkKgQK1PcAXD2kN4-RuyTEMXYNQ0wRGaHIb3vxwqVdjrrVE9yrDMIpAPRgzFwzXbJWvKmxzZpFTUz9RvIqUFt2zNbIG5kLOUyvmKIqO-aTISCT0wu0T0ZEq-DpXJ7-C6z-M0cJJP37y7eV4jdAMx7yD9jT85Knv4_hjLyKvF4We5DSSOYjeIVoq3XHNJdmYJ7X3ph6Ko1CfdtVKNVf20Vx8Z_Zi-pe9bTY0n-tSkwDvVXpVOrb3BOalq7MbOpTe8Klf9uZ_ZIDqTlTnrYV_oh_5isrImv7r8D1NX1G4p9jRcI16MEFDE" }

然后,可以使用另一個命令來訪問需要身份驗證的路由:

curl -X GET    http://your-app-url/api/details    -H 'authorization: Bearer <token>'</token>

在上面的命令中,將替換為上一步中獲得的API令牌。如果令牌有效,則將獲得身份驗證的響應:

{     "user": {         "id": 1,         "name": "User",         "email": "user@example.com",         "email_verified_at": null,         "created_at": "2021-08-13T02:58:04.000000Z",         "updated_at": "2021-08-13T02:58:04.000000Z"     } }
  1. 總結

在本文中,我們介紹了如何使用Laravel Passport實現API身份驗證。使用Laravel Passport,您可以輕松地為您的Web API添加強大的身份驗證支持,讓您的用戶數據更加安全。Laravel Passport還提供了其他強大的功能,如API訪問令牌管理和OAuth2客戶端管理。如果您是Laravel開發者,請務必深入了解Laravel Passport,并在您的下一個Web項目中使用它。

? 版權聲明
THE END
喜歡就支持一下吧
點贊8 分享