php小編小新帶你探索使用laravel passport處理api認(rèn)證,laravel passport是一種完善的oauth2服務(wù)器實(shí)現(xiàn),可幫助開(kāi)發(fā)者輕松實(shí)現(xiàn)api認(rèn)證,并提供了許多便捷功能。通過(guò)本文,你將了解如何使用laravel passport來(lái)管理api用戶身份驗(yàn)證,保障api接口的安全性。
第一步. 安裝 Laravel
我們需要用以下命令來(lái)創(chuàng)建一個(gè)最新的 Laravel 應(yīng)用,所以請(qǐng)打開(kāi)終端執(zhí)行:
laravel new auth
登錄后復(fù)制
第二步. 安裝 Laravel Passport 包
Laravel Passport 可以在幾分鐘內(nèi)為你的應(yīng)用實(shí)現(xiàn)一個(gè)完整的 OAuth2 服務(wù)器。
composer require laravel/passport
登錄后復(fù)制
第三步. 運(yùn)行數(shù)據(jù)庫(kù)遷移
Passport 的遷移會(huì)創(chuàng)建你的應(yīng)用用來(lái)存儲(chǔ)客戶端和 Access Token 的表。
PHP artisan migrate
登錄后復(fù)制
第四步. 生成秘鑰
此命令會(huì)創(chuàng)建秘鑰以用來(lái)生成安全的 Access Token。除此之外,它也會(huì)創(chuàng)建用來(lái)生成 Access Token 的 personal access 和 passWord grant:
php artisan passport:install
登錄后復(fù)制
執(zhí)行完畢后,將 Laravel\Passport\HasApiTokens
trait 添加到你的 App\User
模型中。這個(gè) trait 會(huì)為模型添加一系列助手函數(shù)用來(lái)驗(yàn)證用戶的秘鑰和作用域:
第五步 . 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; }
登錄后復(fù)制
接下來(lái),你應(yīng)該在 AuthServiceProvider
中的 boot
方法中調(diào)用 Passport::routes
方法。這個(gè)方法會(huì)注冊(cè)必要的路由去頒發(fā)訪問(wèn)令牌,撤銷(xiāo)訪問(wèn)令牌,客戶端和個(gè)人令牌:
<?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(); } }
登錄后復(fù)制
最后,在 config/auth.php
配置文件中,你應(yīng)該設(shè)置 api
權(quán)限認(rèn)證守衛(wèi)的 driver
選項(xiàng)為 passport
。當(dāng)需要權(quán)限認(rèn)證的 API 請(qǐng)求進(jìn)來(lái)時(shí)會(huì)告訴你的應(yīng)用去使用 Passport's 的 TokenGuard
。
'guards' => [ 'WEB' => [ 'driver' => 'session', 'provider' => 'users', ], 'api' => [ 'driver' => 'passport', 'provider' => 'users', ], ],
登錄后復(fù)制
第六步. 添加 API 路由
Laravel 提供了 routes/api.php
文件來(lái)給我們編寫(xiě) web 路由,因此在這個(gè)文件添加新的路由即可。
<?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'); }); });
登錄后復(fù)制
第七步: 創(chuàng)建控制器
最后一步我們必須創(chuàng)建新的控制器和 api 方法。因此我們先創(chuàng)建 AuthController
并且把代碼寫(xiě)進(jìn)去:
<?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()); } }
登錄后復(fù)制
現(xiàn)在我們已經(jīng)準(zhǔn)備好運(yùn)行我們的示例了,運(yùn)行下面的命令以快速運(yùn)行:
php artisan serve
登錄后復(fù)制
測(cè)試
現(xiàn)在,我們可以使用 REST 客戶端工具來(lái)簡(jiǎn)化測(cè)試,例如 Postman。我執(zhí)行測(cè)試你可以看見(jiàn)以下的截圖。
你要為這個(gè) API 設(shè)置以下兩個(gè)頭信息:
Content-Type: application/json X-Requested-With: XMLHttpRequest
登錄后復(fù)制
注冊(cè)
登錄
登出
用戶
感謝閱讀!
資源
GitHub
Postman collections