Содержание
- Сделайте аутентификацию REST API в LARAVEL 9 с помощью LARAVEL SANCTUM
- Этапы установки
- Шаг 1
- Шаг 2
- Шаг 3
- ИСПОЛЬЗОВАНИЕ SANCTUM В LARAVEL
- Пользовательский HasApiTokens трейт в AppModelsUser
- Маршруты аутентификации API
- Для защиты API с помощью аутентификации нам необходимо использовать промежуточное ПО auth:sanctum.
Сделайте аутентификацию REST API в LARAVEL 9 с помощью LARAVEL SANCTUM
Laravel Sanctum предоставляет легкую систему аутентификации для SPA (одностраничных приложений), мобильных приложений и простых API, основанных на токенах.
Этапы установки
Если вы не используете LARAVEL 9, вам необходимо установить LARAVEL Sanctum. В противном случае вы можете пропустить шаг установки.
Шаг 1
Установка через composer
composer require laravel/sanctum
Шаг 2
Публикация поставщика услуг Sanctum
php artisan vendor:publish --provider="LaravelSanctumSanctumServiceProvider"
Шаг 3
Перенести базу данных
php artisan migrate
ИСПОЛЬЗОВАНИЕ SANCTUM В LARAVEL
Пользовательский HasApiTokens трейт в AppModelsUser
Для того чтобы использовать Sanctum, нам необходимо использовать класс трейта HasApiTokens в модели пользователя.
Модель пользователя должна выглядеть следующим образом.
<?php
namespace AppModels;
use IlluminateContractsAuthMustVerifyEmail;
use IlluminateDatabaseEloquentFactoriesHasFactory;
use IlluminateFoundationAuthUser as Authenticatable;
use IlluminateNotificationsNotifiable;
use LaravelSanctumHasApiTokens;
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
В файле routesapi.php обновите API
Route::post('/auth/register', [AuthController::class, 'createUser']);
Route::post('/auth/login', [AuthController::class, 'loginUser']);
Теперь обновите AuthContoller с
<?php
namespace AppHttpControllersApi;
use AppModelsUser;
use IlluminateHttpRequest;
use AppHttpControllersController;
use IlluminateSupportFacadesAuth;
use IlluminateSupportFacadesHash;
use IlluminateSupportFacadesValidator;
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');
Вот результаты.
Полное руководство приведено ниже на видео.
Если вы столкнулись с какой-либо проблемой при создании REST API, пожалуйста, прокомментируйте ваш запрос.
Спасибо за прочтение
Свяжитесь со мной.
Twitter
Instagram
Канал YouTube TechToolIndia