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