我們將會學習使用 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
注冊
登錄
登出
用戶
以上就是“使用laravel Passport 處理API 認證系統”的詳細內容，想要了解更多laravel教程歡迎關注編程學習網
掃碼二維碼 獲取免費視頻學習資料
- 本文固定鏈接: http://www.wangchenghua.com/post/8323/
- 轉載請注明：轉載必須在正文中標注并保留原文鏈接
- 掃碼： 掃上方二維碼獲取免費視頻資料