Make REST API AUTHENTICATION in LARAVEL 9 USING LARAVEL SANCTUM
Laravel Sanctum предоставляет полулегкую систему аутентификации для SPA (одностраничных приложений), мобильных приложений и простых API на основе токенов.
Шаги
установки Если вы не используете LARAVEL 9, вам нужно установить LARAVEL Sanctum В противном случае вы можете пропустить шаг установки.
Шаг 1
Установка с помощью композитора
composer require laravel/sanctum
Шаг 2
Опубликуйте поставщика услуг Sanctum
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
Шаг 3
Перенос базы данных
php artisan migrate
ИСПОЛЬЗОВАНИЕ SANCTUM IN LARAVEL
User HasApiTokens
Trait в App\Models\User
Чтобы использовать Sanctum, нам нужно использовать HasApiTokens
Класс признаков в пользовательской модели.
Пользовательская модель должна выглядеть так.
<?php
namespace App\Models;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
class User extends Authenticatable
{
use HasApiTokens, HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}
Маршруты
аутентификации API Создание AuthController
для обработки всей проверки подлинности, реализованной в API
php artisan make:controller Api\\AuthController
В routes\api.php
файле обновления API
Route::post('/auth/register', [AuthController::class, 'createUser']);
Route::post('/auth/login', [AuthController::class, 'loginUser']);
Теперь обновите AuthContoller
с помощью
<?php
namespace App\Http\Controllers\Api;
use App\Models\User;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Validator;
class AuthController extends Controller
{
/**
* Create User
* @param Request $request
* @return User
*/
public function createUser(Request $request)
{
try {
//Validated
$validateUser = Validator::make($request->all(),
[
'name' => 'required',
'email' => 'required|email|unique:users,email',
'password' => 'required'
]);
if($validateUser->fails()){
return response()->json([
'status' => false,
'message' => 'validation error',
'errors' => $validateUser->errors()
], 401);
}
$user = User::create([
'name' => $request->name,
'email' => $request->email,
'password' => Hash::make($request->password)
]);
return response()->json([
'status' => true,
'message' => 'User Created Successfully',
'token' => $user->createToken("API TOKEN")->plainTextToken
], 200);
} catch (\Throwable $th) {
return response()->json([
'status' => false,
'message' => $th->getMessage()
], 500);
}
}
/**
* Login The User
* @param Request $request
* @return User
*/
public function loginUser(Request $request)
{
try {
$validateUser = Validator::make($request->all(),
[
'email' => 'required|email',
'password' => 'required'
]);
if($validateUser->fails()){
return response()->json([
'status' => false,
'message' => 'validation error',
'errors' => $validateUser->errors()
], 401);
}
if(!Auth::attempt($request->only(['email', 'password']))){
return response()->json([
'status' => false,
'message' => 'Email & Password does not match with our record.',
], 401);
}
$user = User::where('email', $request->email)->first();
return response()->json([
'status' => true,
'message' => 'User Logged In Successfully',
'token' => $user->createToken("API TOKEN")->plainTextToken
], 200);
} catch (\Throwable $th) {
return response()->json([
'status' => false,
'message' => $th->getMessage()
], 500);
}
}
}
Защита API с помощью аутентификации нам нужно использовать auth:sanctum
промежуточное ПО.
Route::apiResource('posts', PostController::class)->middleware('auth:sanctum');
Вот результаты.
Полный учебник приведен ниже в видео.
Спасибо, что прочитали