Laravel開發：如何使用Laravel Passport實現API身分驗證？-Laravel-PHP中文網

Laravel開發：如何使用Laravel Passport實現API身分驗證？

PHPz

發布： 2023-06-13 17:34:38

原創

1689 人瀏覽過

Laravel是一個開源的PHP Web應用程式框架，旨在幫助開發者輕鬆建立高效的網頁應用程式。 Laravel Passport是Laravel框架的一部分，它是實作OAuth2協定的身份驗證伺服器，為API開發提供了強大的支援。在本文中，我們將介紹如何使用Laravel Passport實現API身分驗證。

在安裝Laravel Passport

#使用Laravel Passport之前，我們需要先安裝它。可以透過執行以下指令來安裝Laravel Passport：

composer require laravel/passport

登入後複製

安裝完成後，還需要執行php artisan migrate指令來建立所需的資料表。

設定認證中間件

要使用Laravel Passport進行API驗證，我們需要將其與Laravel的認證中介軟體結合使用。可以在app/Http/Kernel.php檔案中為API群組新增對應的認證中間件：

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

登入後複製

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

建立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路由的邏輯。

建立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令牌，並將其傳回給客戶端。

測試API驗證

現在，我們可以透過傳送使用者名稱和密碼來測試API驗證。可以使用Postman或curl等工具執行以下命令：

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"
    }
}

登入後複製

總結

在本文中，我們介紹如何使用Laravel Passport實現API身分驗證。使用Laravel Passport，您可以輕鬆為您的Web API添加強大的身份驗證支持，讓您的用戶資料更加安全。 Laravel Passport也提供了其他強大的功能，例如API存取權杖管理和OAuth2用戶端管理。如果您是Laravel開發者，請務必深入了解Laravel Passport，並在您的下一個Web專案中使用它。

以上是Laravel開發：如何使用Laravel Passport實現API身分驗證？的詳細內容。更多資訊請關注PHP中文網其他相關文章！