使用 Laravel Passport 處理 API 認證

文章轉發自專業的Laravel開發者社區，原始連接：learnku.com/laravel/t/2…

咱們將會學習使用 Laravel 的 Passport API OAuth 來建立一個驗證系統。

第一步. 安裝 Laravel

咱們須要用如下命令來建立一個最新的 Laravel 應用，因此請打開終端執行：

laravel new auth
複製代碼

第二步. 安裝 Laravel Passport 包

Laravel Passport 能夠在幾分鐘內爲你的應用實現一個完整的 OAuth2 服務器。

composer require laravel/passport
複製代碼

第三步. 運行數據庫遷移

Passport 的遷移會建立你的應用用來存儲客戶端和 Access Token 的表。

php artisan migrate
複製代碼

第四步. 生成祕鑰

此命令會建立祕鑰以用來生成安全的 Access Token。除此以外，它也會建立用來生成 Access Token 的 personal access 和 password grant：

php artisan passport:install
複製代碼

執行完畢後，將 Laravel\Passport\HasApiTokens trait 添加到你的 App\User 模型中。這個 trait 會爲模型添加一系列助手函數用來驗證用戶的祕鑰和做用域：

第五步 . Passport 配置

<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Laravel\Passport\HasApiTokens;

class User extends Authenticatable
{
    use Notifiable, HasApiTokens;
}
複製代碼

接下來，你應該在 AuthServiceProvider 中的 boot 方法中調用 Passport::routes 方法。這個方法會註冊必要的路由去頒發訪問令牌，撤銷訪問令牌，客戶端和我的令牌：

<?php

namespace App\Providers;

use Laravel\Passport\Passport;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        'App\Model' => 'App\Policies\ModelPolicy',
    ];
    
    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();
        
        Passport::routes();
    }
}
複製代碼

最後，在 config/auth.php 配置文件中，你應該設置 api 權限認證守衛的 driver 選項爲 passport。當須要權限認證的 API 請求進來時會告訴你的應用去使用 Passport's 的 TokenGuard。

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],
複製代碼

第六步. 添加 API 路由

Laravel 提供了 routes/api.php 文件來給咱們編寫 web 路由，所以在這個文件添加新的路由便可。

<?php

use Illuminate\Http\Request;

Route::group([
    'prefix' => 'auth'
], function () {
    Route::post('login', 'AuthController@login');
    Route::post('signup', 'AuthController@signup');

    Route::group([
      'middleware' => 'auth:api'
    ], function() {
        Route::get('logout', 'AuthController@logout');
        Route::get('user', 'AuthController@user');
    });
});
複製代碼

第七步: 建立控制器

最後一步咱們必須建立新的控制器和 api 方法。所以咱們先建立 AuthController 而且把代碼寫進去：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Carbon\Carbon;
use App\User;

class AuthController extends Controller
{
    /**
     * Create user
     *
     * @param  [string] name
     * @param  [string] email
     * @param  [string] password
     * @param  [string] password_confirmation
     * @return [string] message
     */
    public function signup(Request $request)
    {
        $request->validate([
            'name' => 'required|string',
            'email' => 'required|string|email|unique:users',
            'password' => 'required|string|confirmed'
        ]);
        
        $user = new User([
            'name' => $request->name,
            'email' => $request->email,
            'password' => bcrypt($request->password)
        ]);
        
        $user->save();
        
        return response()->json([
            'message' => 'Successfully created user!'
        ], 201);
    }

    /**
     * Login user and create token
     *
     * @param  [string] email
     * @param  [string] password
     * @param  [boolean] remember_me
     * @return [string] access_token
     * @return [string] token_type
     * @return [string] expires_at
     */
    public function login(Request $request)
    {
        $request->validate([
            'email' => 'required|string|email',
            'password' => 'required|string',
            'remember_me' => 'boolean'
        ]);
        
        $credentials = request(['email', 'password']);
        
        if(!Auth::attempt($credentials))
            return response()->json([
                'message' => 'Unauthorized'
            ], 401);
            
        $user = $request->user();
        
        $tokenResult = $user->createToken('Personal Access Token');
        $token = $tokenResult->token;
        
        if ($request->remember_me)
            $token->expires_at = Carbon::now()->addWeeks(1);
        
        $token->save();
        
        return response()->json([
            'access_token' => $tokenResult->accessToken,
            'token_type' => 'Bearer',
            'expires_at' => Carbon::parse(
                $tokenResult->token->expires_at
            )->toDateTimeString()
        ]);
    }

    /**
     * Logout user (Revoke the token)
     *
     * @return [string] message
     */
    public function logout(Request $request)
    {
        $request->user()->token()->revoke();
        
        return response()->json([
            'message' => 'Successfully logged out'
        ]);
    }

    /**
     * Get the authenticated User
     *
     * @return [json] user object
     */
    public function user(Request $request)
    {
        return response()->json($request->user());
    }
}
複製代碼

如今咱們已經準備好運行咱們的示例了，運行下面的命令以快速運行：

php artisan serve
複製代碼

---

測試

如今，咱們能夠使用 REST 客戶端工具來簡化測試，例如 Postman。我執行測試你能夠看見如下的截圖。

你要爲這個 API 設置如下兩個頭信息：

Content-Type: application/json
X-Requested-With: XMLHttpRequest
複製代碼

註冊

登陸

登出

用戶

---

感謝閱讀！

資源

• GitHub
• Postman collections

引用

• Laravel Passport
• Create REST API in Laravel with authentication using Passport 做者 Urjit Rajgor