php小編小新帶你探索使用Laravel Passport處理API認證,Laravel Passport是一種完善的OAuth2伺服器實現,可幫助開發者輕鬆實現API認證,並提供了許多便捷功能。透過本文,你將了解如何使用Laravel Passport來管理API使用者驗證,確保API介面的安全性。
我們需要用以下指令來建立一個最新的Laravel 應用,所以請開啟終端執行:
laravel new auth
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 會為模型添加一系列助手函數用來驗證使用者的秘鑰和作用域:
<?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 { protected $policies = [ 'App\Model' => 'App\Policies\ModelPolicy', ]; 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', ], ],
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 { 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); } 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() ]); } public function logout(Request $request) { $request->user()->token()->revoke(); return response()->json([ 'message' => 'Successfully logged out' ]); } public function user(Request $request) { return response()->json($request->user()); } }
現在我們已經準備好運行我們的範例了,運行下面的命令以快速運行:
php artisan serve
現在,我們可以使用REST 用戶端工具來簡化測試,例如Postman。我執行測試你可以看見以下的截圖。
你要為這個API 設定以下兩個頭資訊:
Content-Type: application/json X-Requested-With: XMLHttpRequest
註冊
登入
登出
用戶
##感謝閱讀!
以上是使用 Laravel Passport 處理 API 認證的詳細內容。更多資訊請關注PHP中文網其他相關文章!